{"bugs":{"url":"https://github.com/open-telemetry/opentelemetry-js/issues"},"dist":{"shasum":"cf58e9e55f0e8ff59bd4ad1b2b68da1c07128e8e","tarball":"https://registry.npmjs.org/@opentelemetry/exporter-collector/-/exporter-collector-0.18.3-alpha.20.tgz","fileCount":60,"integrity":"sha512-yfynuo3TXB8YVaaMGqbgiSoLWfD5ORiTcQLgOAqQyrCVmMzTGXBOaRNzAy4qY58Py1a6CJlqieUY4MsmL5O4Rw==","signatures":[{"sig":"MEYCIQCEQEkSHBFEp6cA3y1NhcWJ11/jnlUlchOtAHOngcTM3AIhAJYG27VieGfWR7Hgwt1Cf7/Njek/AItiHuROgbxK6os/","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":128629,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgdGKNCRA9TVsSAnZWagAA2ccP/01suSM3PSc6kwOzbXEq\nK73iou83y39y3ZB0XbsDXkHRAMKQ6SNt5Lvi0QEWolzZerpNZUHIsIAt5quu\nJc4VRLmr0AlbfSCcs4nwyUneGSo7QEaK1eqL5eFaOriC+hg9gmnbt/phtlMQ\nm059s0VDeHK0+M6niq57PcARShpvOp6bQ14OHsis7PiGClsy0NJRXy84N52G\nJcZRG+TiS4X1PfKM9SbbpxkOCltzMoQ9t/YY6Ny1m0aXJNKfvLzdZS6Q9ws6\nTnJhh5TZH+BVwm5yfdd2i+edRMD6a17QlZbvql46qwQkz9yIw1NXCYvWCGlo\nCL8VWPXdb7pFVVuEDuHVGfw90ncmUnDsNWNEV6rR9dTTxfEgN1/WVR4u6tx+\ncON1yp+iSxe4wbhwcZxFWR9GlQkty4/21eI3q84zMRaIwjCwTJ8nF1efXG5P\n9ErFe62gxWXi7eyIIpx/ljZ4hbgjEjbcFs5tjS10eE4QNfLfujUjk2XBezP0\ns6VqImFhNGPAXNnSShAREdheXc6nyxKH0zJZ79X5If7GkylbGld+Oip0cp3R\nYQCswIU+5c46f++tHSVRRJlnn52zHNd/i8av7Y8eu/4aMAU8oWJ9jVcyMhpJ\niejWWwph7SGfpiimS+j/2aMch7kO9zsVGoRvtQ6Lz1bkvxKvhkVH0MiWWoKa\nYiD6\r\n=XO/X\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"},"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.16.0**.\n\n## Installation\n\n```bash\nnpm install --save @opentelemetry/exporter-collector\n```\n\n## Traces in Web\n\nThe CollectorTraceExporter in Web expects the endpoint to end in `/v1/trace`.\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  serviceName: 'basic-service',\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  serviceName: 'basic-service',\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","browser":{"./src/platform/index.ts":"./src/platform/browser/index.ts","./build/src/platform/index.js":"./build/src/platform/browser/index.js"},"engines":{"node":">=8.0.0"},"gitHead":"b6dfd978513eb400a706928e604b625961ea7062","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","watch":"tsc --build --watch","compile":"tsc --build","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.16.0+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.16.0","dependencies":{"@opentelemetry/core":"^0.18.3-alpha.20+b6dfd978","@opentelemetry/metrics":"^0.18.3-alpha.20+b6dfd978","@opentelemetry/tracing":"^0.18.3-alpha.20+b6dfd978","@opentelemetry/resources":"^0.18.3-alpha.20+b6dfd978","@opentelemetry/api-metrics":"^0.18.2"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"cpx":"1.5.0","gts":"3.1.0","nyc":"15.1.0","karma":"5.2.3","mocha":"7.2.0","sinon":"10.0.0","rimraf":"3.0.2","codecov":"3.8.1","ts-node":"9.1.1","webpack":"4.46.0","ts-mocha":"8.0.0","ts-loader":"8.1.0","typescript":"4.2.3","@babel/core":"7.13.14","@types/node":"14.14.37","karma-mocha":"2.0.1","webpack-cli":"4.6.0","@types/mocha":"8.2.2","@types/sinon":"9.0.11","babel-loader":"8.2.2","karma-webpack":"5.0.0","webpack-merge":"5.7.3","@opentelemetry/api":"^1.0.0-rc.0","@types/webpack-env":"1.16.0","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.0-rc.0"},"_npmOperationalInternal":{"tmp":"tmp/exporter-collector_0.18.3-alpha.20_1618240140488_0.7809031398934203","host":"s3://npm-registry-packages"},"_id":"@opentelemetry/exporter-collector@0.18.3-alpha.20","version":"0.18.3-alpha.20"}