-
Notifications
You must be signed in to change notification settings - Fork 838
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add examples README.md (#1057)
- Loading branch information
1 parent
e912842
commit b87764e
Showing
1 changed file
with
29 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |