From b87764ec4e52e7e87530477d236bfc039dd024ec Mon Sep 17 00:00:00 2001 From: Mayur Kale Date: Wed, 20 May 2020 07:49:54 -0700 Subject: [PATCH] chore: add examples README.md (#1057) --- examples/README.md | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 examples/README.md diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000000..9c7a2f94e7 --- /dev/null +++ b/examples/README.md @@ -0,0 +1,29 @@ +# OpenTelemetry JavaScript Examples + +This directory contains a number of examples of how to run real applications +with OpenTelemetry JavaScript. + +### Maintained Examples + +Maintained Examples are expected to be updated with every OpenTelemetry JavaScript release, to +use the latest and greatest features, and best practices. + +|Name | Description | Complexity Level | +------------- | ------------- | ------------ | +|[basic-tracer-node](basic-tracer-node/) | Basic use of Tracing in Node.js application | Beginner | +|[tracer-node](tracer-node/) | Basic use of Tracing in Web application | Beginner | +|[prometheus](prometheus/) | Basic Metric use with Prometheus (`@opentelemetry/exporter-prometheus`) Exporter | Beginner | +|[http](http/) | HTTP Instrumentation to automatically collect trace data and export them to the backend of choice | Intermediate | +|[https](https/) | HTTPS Instrumentation to automatically collect trace data and export them to the backend of choice | Intermediate | +|[grpc](grpc/) | gRPC Instrumentation to automatically collect trace data and export them to the backend of choice | Intermediate | +|[express](express/) | Express Instrumentation to automatically collect trace data and export them to the backend of choice | Intermediate | +|[collector-exporter-node](collector-exporter-node/) | This example shows how to use `@opentelemetry/exporter-collector` to instrument a simple Node.js application | Intermediate | +|[opentracing-shim](opentracing-shim/) | This is a simple example that demonstrates how existing OpenTracing instrumentation can be integrated with OpenTelemetry | Intermediate | + +### Contributing + +Please see [CONTRIBUTING.md](https://github.com/open-telemetry/opentelemetry-js/blob/master/CONTRIBUTING.md) for instructions on how to contribute. + +## LICENSE + +Apache License 2.0