{"_id":"@danielkoehler/exporter-zpages","_rev":"1-7ff61e7f4a2adbcd7a255d95727fd976","name":"@danielkoehler/exporter-zpages","dist-tags":{"latest":"0.0.9"},"versions":{"0.0.9":{"name":"@danielkoehler/exporter-zpages","version":"0.0.9","description":"A collection of HTML pages to display stats and trace data and allow library configuration control","main":"build/src/index.js","types":"build/src/index.d.ts","repository":{"type":"git","url":"git+https://github.com/census-instrumentation/opencensus-node.git"},"scripts":{"test":"nyc mocha build/test/**/*.js","codecov":"nyc report --reporter=json && codecov -f coverage/*.json","clean":"rimraf build/*","check":"gts check","compile":"tsc -p .","fix":"gts fix","prepare":"npm run compile","pretest":"npm run compile","posttest":"npm run check"},"keywords":["opencensus","nodejs","tracing","profiling"],"author":{"name":"Google Inc."},"license":"Apache-2.0","engines":{"node":">=6.0"},"publishConfig":{"access":"public"},"devDependencies":{"@danielkoehler/nodejs":"^0.0.9","@types/ejs":"^2.6.0","@types/express":"^4.11.1","@types/extend":"^3.0.0","@types/mocha":"^5.2.5","@types/node":"^10.12.12","@types/pkg-dir":"^2.0.0","axios":"^0.18.0","codecov":"^3.1.0","gts":"^0.9.0","mocha":"^6.0.0","nyc":"13.3.0","rimraf":"^2.6.2","ts-node":"^8.0.0","typescript":"~3.2.0"},"dependencies":{"@danielkoehler/core":"^0.0.9","ejs":"^2.5.8","express":"^4.16.3","pkg-dir":"^3.0.0"},"contributors":[{"name":"Google LLC"},{"name":"CESAR Team","url":"www.cesar.org.br"}],"bugs":{"url":"https://github.com/census-instrumentation/opencensus-node/issues"},"homepage":"https://github.com/census-instrumentation/opencensus-node#readme","_id":"@danielkoehler/exporter-zpages@0.0.9","_shasum":"a0d622431ade24366fada55e103960231382593a","_from":".","_npmVersion":"3.10.10","_nodeVersion":"6.16.0","_npmUser":{"name":"danielkoehler","email":"koehlerda@icloud.com"},"dist":{"shasum":"a0d622431ade24366fada55e103960231382593a","tarball":"https://registry.npmjs.org/@danielkoehler/exporter-zpages/-/exporter-zpages-0.0.9.tgz","integrity":"sha512-uugsk0Mvs2DPPn+I8Y9IdSjdAo8i1CQrlzQsxaB5BAC2gQzH6NH1+ElVfcvwZ8wFg+Ty3hrT0Yd0/VDNtfQTXw==","fileCount":17,"unpackedSize":47745,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJchmdcCRA9TVsSAnZWagAAfTMP/R8oEfvk64qiM2QZdkL6\nN5cBrMKA9W/s/vYEKyp8LaqaU/lQS/LnMqhBGie66qiRbU9J5ulG+asBmqcM\n6aEBb2Q3U1JVldHXvj0qYWLTETEmPRGVQCcUlGyHU0HFzlrXm+gVlsrvMDi4\nvCHyPZABoP+ZnRjmxQ2mQRX0eCPw9P7wXyPtq4UkCb1msxCc1u1gk46gGHxB\nUgr2ZOw8v3LTWWksi2UeUJ+yyFvEYR8zHTRv/Xx07STTEkQYewsvw1UqJ3Zm\n58ucwgbdjt2POjZdCW2IUP2EwpcYTpBTWwcin9GWh5rGeiItKa5GdKDBwFW4\nwFFnikxVwPvIL3hpS8aWDb6QZPb18WpbAMapG1qy90SDO7KpcTuHwkUz9N0a\n/V3NaUWXTiXb6b8FmAZcDo2blqSIbwV2f3ogrJYcLBZ/q1RstL5dkzZSn6yh\nflKm9LC3O1q3QpOdneujS5/rCUrYxktLqEbVmRgfSJrNNw8K8slYtXW+D7Cr\n+3OsRIMrs/wnzRzsxZxLt7IG4pMPN1u0nsuEwuxoPgVqcG20BhngpvkrNobs\npI816m4VmhQ8AAd7lQ/gBbKp1In8yVyruK095PQqFTW/6KP9GsW08uuZ70pT\n+YAQ0ACnzWEo/swbaKtzR+QNE8bXMzA6sU4cJpgTZCn2uRq7y24geQd8M4WJ\nlBqI\r\n=Q0JR\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDk6vKpsQLDfKQhsOn6Lt9MzZVHZhq/wNAF+gTa5rSJqwIhAKNSWipzsUWvv6CdJrNrOPJ1ICaPTZY3FVLAu74DO9vi"}]},"maintainers":[{"name":"danielkoehler","email":"koehlerda@icloud.com"}],"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/exporter-zpages_0.0.9_1552312154872_0.34281820404092067"},"_hasShrinkwrap":false}},"time":{"created":"2019-03-11T13:49:14.631Z","0.0.9":"2019-03-11T13:49:15.614Z","modified":"2022-04-05T02:41:08.157Z"},"maintainers":[{"name":"danielkoehler","email":"koehlerda@icloud.com"}],"description":"A collection of HTML pages to display stats and trace data and allow library configuration control","homepage":"https://github.com/census-instrumentation/opencensus-node#readme","keywords":["opencensus","nodejs","tracing","profiling"],"repository":{"type":"git","url":"git+https://github.com/census-instrumentation/opencensus-node.git"},"contributors":[{"name":"Google LLC"},{"name":"CESAR Team","url":"www.cesar.org.br"}],"author":{"name":"Google Inc."},"bugs":{"url":"https://github.com/census-instrumentation/opencensus-node/issues"},"license":"Apache-2.0","readme":"# OpenCensus Zpages Exporter for Node.js\n[![Gitter chat][gitter-image]][gitter-url]\n\nOpenCensus Zpages Exporter implements a collection of HTML pages that display stats and trace data sent from [OpenCensus Node.js](https://github.com/census-instrumentation/opencensus-node).\n\nThis project is still at an early stage of development. It's subject to change.\n\n## Installation\n\n```node\nnpm install @opencensus/nodejs\nnpm install @opencensus/exporter-zpages\n```\n\n## Usage\n\nZpages always runs on localhost, but you can change the port in the options. If the option `startServer` is set to `true`, Zpages server will start when a new Zpages instance is created. It's also possible to predefined some span names. These empty spans will be listed on Zpages.\n\nTo use Zpages, instance the exporter on your application and pass the options. For javascript:\n\n```javascript\nconst tracing = require('@opencensus/nodejs');\nconst zpages = require('@opencensus/exporter-zipkin');\n\n// Add your zipkin url and application name to the Zipkin options\nconst options = {\n  port: 8080,   // default\n  startServer: true,  // default\n  spanNames: ['predefined/span1', 'predefined/span2']\n}\n\nconst exporter = new zpages.ZpagesExporter(options);\n```\n\nSimilarly for Typescript:\n\n```typescript\nimport * as tracing from '@opencensus/nodejs';\nimport {ZpagesExporter, ZpagesExporterOptions} from '@opencensus/zpages-exporter';\n\n// Add your zipkin url and application name to the Zipkin options\nconst options = {\n  port: 8080,   // default\n  startServer: true,  // default\n  spanNames: ['predefined/span1', 'predefined/span2']\n} as ZpagesExporterOptions;\n\nconst exporter = new ZpagesExporter(options);\n```\n\nNow, register the exporter and start tracing.\n\n```javascript\ntracing.start({'exporter': exporter});\n```\n\nor\n\n```javascript\ntracing.registerExporter(exporter).start();\n```\n\n### Starting the Zpages server\n\nIf `options.startServer` is set to `false`, the server can be started by calling `startServer` method:\n\n```typescript\nzpages.startServer();\n```\n\nThe server will run at `http:\\\\localhost:port`.\n\n### Browsing the Zpages pages\n\nThere are four pages you can browse.\n\n- **/tracez**: Trace list.\n\n- **/traceconfigz**: Trace settings.\n\n- **/rpcz**: RPC stats *(not yet implemented)*.\n\n- **/stats**: Stats page *(not yet implemented)*.\n\n### Stoping the Zpages server\n\nIf it is necessary to stop the server programmatically, use the following command:\n\n```typescript\nzpages.stopServer();\n```\n\n## Useful links\n- For more information on OpenCensus, visit: <https://opencensus.io/>\n- To checkout the OpenCensus for Node.js, visit: <https://github.com/census-instrumentation/opencensus-node>\n- For help or feedback on this project, join us on [gitter](https://gitter.im/census-instrumentation/Lobby)\n\n[gitter-image]: https://badges.gitter.im/census-instrumentation/lobby.svg\n[gitter-url]: https://gitter.im/census-instrumentation/lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge\n","readmeFilename":"README.md"}