df225e022d
* docs: add example for express plugin #800 * chore: add link to express example in plugin's readme * chore: addres PR's comments |
||
|---|---|---|
| .. | ||
| images | ||
| README.md | ||
| client.js | ||
| package.json | ||
| server.js | ||
| tracer.js | ||
README.md
Overview
OpenTelemetry Express Instrumentation allows the user to automatically collect trace data and export them to the backend of choice (we can use Zipkin or Jaeger for this example), to give observability to distributed systems.
This is a simple example that demonstrates tracing calls made to Express API. The example shows key aspects of tracing such as
- Root Span (on Client)
- Child Span (on Client)
- Span Events
- Span Attributes
Installation
$ # from this directory
$ npm install
Setup Zipkin Tracing or Setup Jaeger Tracing
Run the Application
Zipkin
-
Run the server
# from this directory $ npm run zipkin:server -
Run the client
# from this directory npm run zipkin:client
Zipkin UI
zipkin:server script should output the traceid in the terminal (e.g traceid: 4815c3d576d930189725f1f1d1bdfcc6).
Go to Zipkin with your browser http://localhost:9411/zipkin/traces/(your-trace-id) (e.g http://localhost:9411/zipkin/traces/4815c3d576d930189725f1f1d1bdfcc6)
Jaeger
-
Run the server
# from this directory $ npm run jaeger:server -
Run the client
# from this directory npm run jaeger:client
Jaeger UI
jaeger:server script should output the traceid in the terminal (e.g traceid: 4815c3d576d930189725f1f1d1bdfcc6).
Go to Jaeger with your browser http://localhost:16686/trace/(your-trace-id) (e.g http://localhost:16686/trace/4815c3d576d930189725f1f1d1bdfcc6)
Useful links
- For more information on OpenTelemetry, visit: https://opentelemetry.io/
- For more information on OpenTelemetry for Node.js, visit: https://github.com/open-telemetry/opentelemetry-js/tree/master/packages/opentelemetry-node
LICENSE
Apache License 2.0