{"bugs":{"url":"https://github.com/open-telemetry/opentelemetry-js/issues"},"dist":{"shasum":"128f24a2a35e82dacf6ec1cda35831a96eddf191","tarball":"https://registry.npmjs.org/@opentelemetry/plugin-http/-/plugin-http-0.18.3-alpha.7.tgz","fileCount":18,"integrity":"sha512-1dMrmcnWInh+TbJVM91QeBy4qOSJN8gBArIIF7baH60Jnw+qCJ4vU1q5Lsdi+bx1xQ0LlZZ3pFO2mMhP0Dpvkg==","signatures":[{"sig":"MEUCIFjp/FfmZCu84FYfSsI10xzIyd7guIdcSJ96fEGf6iH1AiEA+NEhKhZ7RGG/bPR8GDKtzzwnSX9aR4Rfs0zi0+ZUazI=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":84422,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgbdniCRA9TVsSAnZWagAAZNYP/2eyOaXXbunQ461G32P0\nPm6rUU8J/xi9z60Ly5wWrwJfXK134ZeUxyk6+6Vqser144+KihACIDcBx6KC\n9iifAxy/m7Pfeg1HYXVi+teOZ1V2TzMaXOr51KbQo+1MdF74XMgkaGbAJOh6\nIJnrqQCfjkFNry8qdNTVto8lAfZs8uo/gs02ye/nxRNKDDN2PCrkEtXPNmeu\n2CSt5wIy2T7gH5uri1054NdQeMhrjQ/gSYbHS79H4+67qEzt+dQrqVf9N4JD\nqGu8La6TU6Q6ah3xIZ19shzMcVvhwfwDSOse6Kn34n6ven1r3z28OKvRtQo0\njRG6Rkuiv/g+mLxT/3urw5qU29igVQpqdcZo2E42nKRDHElrG1g3Hk2yrLHh\nvT9UBoegpnSQrnARIxfhY1QIgipLHiIulUBvi/ai0nKBk15ItbJcYMdPHWdh\ngdl9/1QN+osUmH/tWADiW/c1+HOkEHl4g6NIiRbf8lQkg8hAmy7upgyNcvO4\nd+MnwmnxdPuKANaM5tngE+bSwZgm8FO3skUXkNUWlwW9xCuG9j9OmLAE5DH+\nBAZlCzoAn9n/YCL6lOHkoqPWAi4oUJqViiNCPU+pVJKdcqJZXUtbXctN6Cqz\n+eTd+EAUCwKA1AFGn1exETVS00gd/Qs5lEaS/NVdUfkfo+q0F0iVF59PUY6P\n6NHA\r\n=oRmh\r\n-----END PGP SIGNATURE-----\r\n"},"main":"build/src/index.js","name":"@opentelemetry/plugin-http","types":"build/src/index.d.ts","author":{"name":"OpenTelemetry Authors"},"readme":"# OpenTelemetry HTTP Instrumentation for Node.js\n\n[![NPM Published Version][npm-img]][npm-url]\n[![dependencies][dependencies-image]][dependencies-url]\n[![devDependencies][devDependencies-image]][devDependencies-url]\n[![Apache License][license-image]][license-image]\n\nThis module provides automatic instrumentation for [`http`](https://nodejs.org/api/http.html).\n\nFor automatic instrumentation see the\n[@opentelemetry/node](https://github.com/open-telemetry/opentelemetry-js/tree/main/packages/opentelemetry-node) package.\n\n## Installation\n\n```bash\nnpm install --save @opentelemetry/plugin-http\n```\n\n## Usage\n\nOpenTelemetry HTTP Instrumentation allows the user to automatically collect trace data and export them to their backend of choice, to give observability to distributed systems.\n\nTo load a specific plugin (HTTP in this case), specify it in the Node Tracer's configuration.\n\n```js\nconst { NodeTracerProvider } = require('@opentelemetry/node');\n\nconst provider = new NodeTracerProvider({\n  plugins: {\n    http: {\n      enabled: true,\n      // You may use a package name or absolute path to the file.\n      path: '@opentelemetry/plugin-http',\n      // http plugin options\n    }\n  }\n});\n```\n\nTo load all of the [supported plugins](https://github.com/open-telemetry/opentelemetry-js#plugins), use below approach. Each plugin is only loaded when the module that it patches is loaded; in other words, there is no computational overhead for listing plugins for unused modules.\n\n```js\nconst { NodeTracerProvider } = require('@opentelemetry/node');\n\nconst provider = new NodeTracerProvider();\n```\n\nSee [examples/http](https://github.com/open-telemetry/opentelemetry-js/tree/main/examples/http) for a short example.\n\n### Http Plugin Options\n\nHttp plugin has few options available to choose from. You can set the following:\n\n| Options | Type | Description |\n| ------- | ---- | ----------- |\n| [`applyCustomAttributesOnSpan`](https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-plugin-http/src/types.ts#L52) | `HttpCustomAttributeFunction` | Function for adding custom attributes |\n| [`requestHook`](https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-plugin-http/src/types.ts#L60) | `HttpRequestCustomAttributeFunction` | Function for adding custom attributes before request is handled |\n| [`responseHook`](https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-plugin-http/src/types.ts#L67) | `HttpResponseCustomAttributeFunction` | Function for adding custom attributes before response is handled |\n| [`ignoreIncomingPaths`](https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-plugin-http/src/types.ts#L28) | `IgnoreMatcher[]` | Http plugin will not trace all incoming requests that match paths |\n| [`ignoreOutgoingUrls`](https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-plugin-http/src/types.ts#L28) | `IgnoreMatcher[]` | Http plugin will not trace all outgoing requests that match urls |\n| [`serverName`](https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-plugin-http/src/types.ts#L28) | `string` | The primary server name of the matched virtual host. |\n| `requireParentforOutgoingSpans` | Boolean | Require that is a parent span to create new span for outgoing requests. |\n| `requireParentforIncomingSpans` | Boolean | Require that is a parent span to create new span for incoming requests. |\n\n## Useful links\n\n- For more information on OpenTelemetry, visit: <https://opentelemetry.io/>\n- For more about OpenTelemetry JavaScript: <https://github.com/open-telemetry/opentelemetry-js>\n- For help or feedback on this project, join us in [GitHub Discussions][discussions-url]\n\n## License\n\nApache 2.0 - See [LICENSE][license-url] for more information.\n\n[discussions-url]: https://github.com/open-telemetry/opentelemetry-js/discussions\n[license-url]: https://github.com/open-telemetry/opentelemetry-js/blob/main/LICENSE\n[license-image]: https://img.shields.io/badge/license-Apache_2.0-green.svg?style=flat\n[dependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js.svg?path=packages%2Fopentelemetry-plugin-http\n[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-plugin-http\n[devDependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js.svg?path=packages%2Fopentelemetry-plugin-http&type=dev\n[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-plugin-http&type=dev\n[npm-url]: https://www.npmjs.com/package/@opentelemetry/plugin-http\n[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fplugin-http.svg\n","engines":{"node":">=8.0.0"},"gitHead":"897c35f497363ee3f3ea4c1e5ad1628e09ec9041","license":"Apache-2.0","scripts":{"tdd":"npm run test -- --watch-extensions ts --watch","lint":"eslint . --ext .ts","test":"nyc ts-mocha -p tsconfig.json test/**/*.test.ts","clean":"tsc --build --clean","watch":"tsc --build --watch","codecov":"nyc report --reporter=json && codecov -f coverage/*.json -p ../../","compile":"tsc --build","version":"node ../../scripts/version-update.js","lint:fix":"eslint . --ext .ts --fix"},"_npmUser":{"name":"dyladan","email":"dyladan@gmail.com"},"homepage":"https://github.com/open-telemetry/opentelemetry-js#readme","keywords":["opentelemetry","http","nodejs","tracing","profiling","plugin"],"repository":{"url":"git+https://github.com/open-telemetry/opentelemetry-js.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v14.16.0+x64 (linux)","description":"OpenTelemetry http automatic instrumentation package.","directories":{},"maintainers":[{"name":"mayurkale22","email":"mayurkale22@gmail.com"},{"name":"bogdandrutu","email":"bogdandrutu@gmail.com"},{"name":"dyladan","email":"dyladan@gmail.com"},{"name":"obecny","email":"bobecny@gmail.com"}],"_nodeVersion":"14.16.0","dependencies":{"semver":"^7.1.3","shimmer":"^1.2.1","@opentelemetry/core":"^0.18.3-alpha.7+897c35f4","@opentelemetry/semantic-conventions":"^0.18.2"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"got":"9.6.0","gts":"3.1.0","nyc":"15.1.0","nock":"12.0.3","axios":"0.21.1","mocha":"7.2.0","sinon":"9.2.4","rimraf":"3.0.2","codecov":"3.8.1","request":"2.88.2","ts-node":"9.1.1","ts-mocha":"8.0.0","@types/got":"9.6.11","superagent":"6.1.0","typescript":"4.2.3","@types/node":"14.14.37","@types/mocha":"8.2.2","@types/sinon":"9.0.11","@types/semver":"7.3.4","@types/shimmer":"1.0.1","@types/superagent":"4.1.10","@opentelemetry/api":"^1.0.0-rc.0","@opentelemetry/node":"^0.18.3-alpha.7+897c35f4","@opentelemetry/tracing":"^0.18.3-alpha.7+897c35f4","request-promise-native":"1.0.9","@types/request-promise-native":"1.0.17","@opentelemetry/context-async-hooks":"^0.18.2"},"peerDependencies":{"@opentelemetry/api":"^1.0.0-rc.0"},"_npmOperationalInternal":{"tmp":"tmp/plugin-http_0.18.3-alpha.7_1617811937789_0.13279266647461152","host":"s3://npm-registry-packages"},"_id":"@opentelemetry/plugin-http@0.18.3-alpha.7","version":"0.18.3-alpha.7"}