{"bugs":{"url":"https://github.com/open-telemetry/opentelemetry-js/issues"},"dist":{"shasum":"59ad7f971bae94ed0e8cdc24b6dd6fe6e0f21bf6","tarball":"https://registry.npmjs.org/@opentelemetry/exporter-collector/-/exporter-collector-0.23.1-alpha.28.tgz","fileCount":117,"integrity":"sha512-+75fyE+Dg9AGpdTmxLJGKd2NYTFXv3QmSDvE5361gJVWlk7kee34NFZelp4acn47qZjocLD5OL2ghkitLv8tzQ==","signatures":[{"sig":"MEUCIQCKSRPZ0yt4GpWsKozjLLNLlF8N0T0mJSlOkJJK+DgLvgIgUVdiqufbNxb+RIkAjMOuqsqfmS/YjfFwwNtDaB0Mqjg=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":244294,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhAGIeCRA9TVsSAnZWagAAengP/RS+4grzjQeAYekz6aoq\nGHcioaP8ZTwJHt9nYVFLq8vP5cdUDIDADcvv92F54CgLOj2Zs9pt8k93K0Wm\nh3NjPWr4oGn5BOsTk8tQRDkEjrsaUm664+v+wJ5KqGEiTmBJFWeBh4vHrdMl\nxcyLPH5ZSHQ1eBENhhYJMAvCQPFgFUf7PEXyObnA+4WcFKuRah1Rxumd8ZUi\n35tu6IYAXzonKllDgTAowL9qIjSNaiMIzcpn5UWQs2ibq1I5YUKwUWwfEH+s\ndJADRfQg7HVAthuqBjQZtdPWvrfRwxOw+A+aFaqG0XPeu9Z7GsJB/cSGVerY\nHf8SotCaB1Ch7qNgQ1qDWvjwBqPsBUDrSnbo3chwKnDz5vZwqp7bLrPi3Fkr\npP3EnNI869t+KzsSpU6bWUOIWirKRl9E3N/d87YW3ay1cL2o5ewmNnapYPkH\n3AAJ4caqJyylDbP8Q74/Ful8YDR/levKXNl13CbwgikbBPnalZ2fFYb53MKP\ngMaKGk/hjaDJ6dcY8NJ+wJv6mLFRE4j+NE/N/4uMdZlvCN8g/IUqnhZDwf18\nNHXqBKK3+TRnqnJsZAJ48WATO9t1UmsbyGBlbzXI+y5yqWSMSvqET5pSaxTQ\ny7rRUXHVLYM80iN9v0z4rQlxjG3n51PyAuW0SRIZ4Un3ebvRO/DiZCWMzMMA\nyi1+\r\n=nrf1\r\n-----END PGP SIGNATURE-----\r\n"},"main":"build/src/index.js","name":"@opentelemetry/exporter-collector","types":"build/src/index.d.ts","author":{"name":"OpenTelemetry Authors"},"module":"build/esm/index.js","readme":"# OpenTelemetry Collector Exporter for web and node\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 exporter for web and node to be used with [opentelemetry-collector][opentelemetry-collector-url] - last tested with version **0.25.0**.\n\n## Installation\n\n```bash\nnpm install --save @opentelemetry/exporter-collector\n```\n\n## Service Name\n\nThe OpenTelemetry Collector Exporter does not have a service name configuration.\nIn order to set the service name, use the `service.name` resource attribute as prescribed in the [OpenTelemetry Resource Semantic Conventions][semconv-resource-service-name].\n\n## Traces in Web\n\nThe CollectorTraceExporter in Web expects the endpoint to end in `/v1/traces`.\n\n```js\nimport { BatchSpanProcessor } from '@opentelemetry/tracing';\nimport { WebTracerProvider } from '@opentelemetry/web';\nimport { CollectorTraceExporter } from '@opentelemetry/exporter-collector';\n\nconst collectorOptions = {\n  url: '<opentelemetry-collector-url>', // url is optional and can be omitted - default is http://localhost:55681/v1/trace\n  headers: {}, // an optional object containing custom headers to be sent with each request\n  concurrencyLimit: 10, // an optional limit on pending requests\n};\n\nconst provider = new WebTracerProvider();\nconst exporter = new CollectorTraceExporter(collectorOptions);\nprovider.addSpanProcessor(new BatchSpanProcessor(exporter, {\n  // The maximum queue size. After the size is reached spans are dropped.\n  maxQueueSize: 100,\n  // The maximum batch size of every export. It must be smaller or equal to maxQueueSize.\n  maxExportBatchSize: 10,\n  // The interval between two consecutive exports\n  scheduledDelayMillis: 500,\n  // How long the export can run before it is cancelled\n  exportTimeoutMillis: 30000,\n}));\n\nprovider.register();\n\n```\n\n## Metrics in Web\n\nThe CollectorMetricExporter in Web expects the endpoint to end in `/v1/metrics`.\n\n```js\nimport { MeterProvider } from '@opentelemetry/metrics';\nimport { CollectorMetricExporter } from '@opentelemetry/exporter-collector';\nconst collectorOptions = {\n  url: '<opentelemetry-collector-url>', // url is optional and can be omitted - default is http://localhost:55681/v1/metrics\n  headers: {}, // an optional object containing custom headers to be sent with each request\n  concurrencyLimit: 1, // an optional limit on pending requests\n};\nconst exporter = new CollectorMetricExporter(collectorOptions);\n\n// Register the exporter\nconst meter = new MeterProvider({\n  exporter,\n  interval: 60000,\n}).getMeter('example-meter');\n\n// Now, start recording data\nconst counter = meter.createCounter('metric_name');\ncounter.add(10, { 'key': 'value' });\n\n```\n\n## Traces in Node - JSON over http\n\n```js\nconst { BasicTracerProvider, BatchSpanProcessor } = require('@opentelemetry/tracing');\nconst { CollectorTraceExporter } =  require('@opentelemetry/exporter-collector');\n\nconst collectorOptions = {\n  url: '<opentelemetry-collector-url>', // url is optional and can be omitted - default is http://localhost:55681/v1/trace\n  headers: {\n    foo: 'bar'\n  }, // an optional object containing custom headers to be sent with each request will only work with http\n  concurrencyLimit: 10, // an optional limit on pending requests\n};\n\nconst provider = new BasicTracerProvider();\nconst exporter = new CollectorTraceExporter(collectorOptions);\nprovider.addSpanProcessor(new BatchSpanProcessor(exporter, {\n  // The maximum queue size. After the size is reached spans are dropped.\n  maxQueueSize: 1000,\n  // The interval between two consecutive exports\n  scheduledDelayMillis: 30000,\n}));\n\nprovider.register();\n\n```\n\n## Metrics in Node\n\n```js\nconst { MeterProvider } = require('@opentelemetry/metrics');\nconst { CollectorMetricExporter } =  require('@opentelemetry/exporter-collector');\nconst collectorOptions = {\n  url: '<opentelemetry-collector-url>', // url is optional and can be omitted - default is http://localhost:55681/v1/metrics\n  concurrencyLimit: 1, // an optional limit on pending requests\n};\nconst exporter = new CollectorMetricExporter(collectorOptions);\n\n// Register the exporter\nconst meter = new MeterProvider({\n  exporter,\n  interval: 60000,\n}).getMeter('example-meter');\n\n// Now, start recording data\nconst counter = meter.createCounter('metric_name');\ncounter.add(10, { 'key': 'value' });\n\n```\n\n## GRPC\n\nFor GRPC please check [npm-url-grpc]\n\n## PROTOBUF\n\nFor PROTOBUF please check [npm-url-proto]\n\n## Running opentelemetry-collector locally to see the traces\n\n1. Go to examples/collector-exporter-node\n2. run `npm run docker:start`\n3. Open page at `http://localhost:9411/zipkin/` to observe the traces\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-exporter-collector\n[dependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-exporter-collector\n[devDependencies-image]: https://status.david-dm.org/gh/open-telemetry/opentelemetry-js.svg?path=packages%2Fopentelemetry-exporter-collector&type=dev\n[devDependencies-url]: https://david-dm.org/open-telemetry/opentelemetry-js?path=packages%2Fopentelemetry-exporter-collector&type=dev\n[npm-url]: https://www.npmjs.com/package/@opentelemetry/exporter-collector\n[npm-url-grpc]: https://www.npmjs.com/package/@opentelemetry/exporter-collector-grpc\n[npm-url-proto]: https://www.npmjs.com/package/@opentelemetry/exporter-collector-proto\n[npm-img]: https://badge.fury.io/js/%40opentelemetry%2Fexporter-collector.svg\n[opentelemetry-collector-url]: https://github.com/open-telemetry/opentelemetry-collector\n[semconv-resource-service-name]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/resource/semantic_conventions/README.md#service\n","browser":{"./src/platform/index.ts":"./src/platform/browser/index.ts","./build/esm/platform/index.js":"./build/esm/platform/browser/index.js","./build/src/platform/index.js":"./build/src/platform/browser/index.js"},"engines":{"node":">=8.0.0"},"gitHead":"d8fbeddacce3e27aab40b24c2ca3c271155e74ea","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' --exclude 'test/browser/**/*.ts'","clean":"tsc --build --clean tsconfig.json tsconfig.esm.json","watch":"tsc --build --watch tsconfig.json tsconfig.esm.json","compile":"tsc --build tsconfig.json tsconfig.esm.json","version":"node ../../scripts/version-update.js","lint:fix":"eslint . --ext .ts --fix","tdd:browser":"karma start","test:browser":"nyc karma start --single-run","codecov:browser":"nyc report --reporter=json && codecov -f coverage/*.json -p ../../"},"_npmUser":{"name":"dyladan","email":"dyladan@gmail.com"},"homepage":"https://github.com/open-telemetry/opentelemetry-js#readme","keywords":["opentelemetry","nodejs","browser","tracing","profiling","metrics","stats"],"deprecated":"Please use trace and metric specific exporters @opentelemetry/exporter-trace-otlp-http and @opentelemetry/exporter-metrics-otlp-http","repository":{"url":"git+https://github.com/open-telemetry/opentelemetry-js.git","type":"git"},"_npmVersion":"lerna/3.22.1/node@v14.17.3+x64 (linux)","description":"OpenTelemetry Collector Exporter allows user to send collected traces to the OpenTelemetry Collector","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.17.3","dependencies":{"@opentelemetry/core":"^0.23.1-alpha.28+d8fbedda","@opentelemetry/metrics":"^0.23.1-alpha.28+d8fbedda","@opentelemetry/tracing":"^0.23.1-alpha.28+d8fbedda","@opentelemetry/resources":"^0.23.1-alpha.28+d8fbedda","@opentelemetry/api-metrics":"^0.23.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"cpx":"1.5.0","nyc":"15.1.0","karma":"5.2.3","mocha":"7.2.0","sinon":"11.1.2","rimraf":"3.0.2","codecov":"3.8.3","webpack":"4.46.0","ts-mocha":"8.0.0","ts-loader":"8.3.0","typescript":"4.3.5","@babel/core":"7.14.8","@types/node":"14.17.5","karma-mocha":"2.0.1","webpack-cli":"4.7.2","@types/mocha":"8.2.3","@types/sinon":"10.0.2","babel-loader":"8.2.2","karma-webpack":"4.0.2","webpack-merge":"5.8.0","@opentelemetry/api":"^1.0.1","@types/webpack-env":"1.16.2","karma-spec-reporter":"0.0.32","karma-chrome-launcher":"3.1.0","istanbul-instrumenter-loader":"3.0.1","karma-coverage-istanbul-reporter":"3.0.3"},"peerDependencies":{"@opentelemetry/api":"^1.0.1"},"_npmOperationalInternal":{"tmp":"tmp/exporter-collector_0.23.1-alpha.28_1627415070281_0.7346599597306314","host":"s3://npm-registry-packages"},"_id":"@opentelemetry/exporter-collector@0.23.1-alpha.28","version":"0.23.1-alpha.28"}