docs: add ioredis example

examples/ioredis/README.md

@@ -0,0 +1,55 @@
+# Overview
+
+OpenTelemetry IORedis 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.
+
+## Tracing backend setup
+
+### Zipkin
+
+- Setup [Zipkin Tracing](https://zipkin.io/pages/quickstart.html)
+
+- Set EXPORTER variable
+
+  ```sh
+  export EXPORTER=zipkin
+  ```
+
+### Jaeger
+
+- Setup [Jaeger Tracing](https://www.jaegertracing.io/docs/latest/getting-started/#all-in-one)
+
+- Set EXPORTER variable
+
+  ```sh
+  export EXPORTER=jaeger
+  ```
+
+## Installation
+
+```sh
+npm install
+```
+
+## Run the Application
+
+- Start redis via docker
+
+   ```sh
+   npm run docker:start
+   ```
+
+- Run the main program
+
+   ```sh
+   npm start
+   ```
+
+- Cleanup docker
+
+   ```sh
+   npm run docker:stop
+   ```
+
+## LICENSE
+
+Apache License 2.0

examples/ioredis/index.js

@@ -0,0 +1,20 @@
+'use strict';
+
+// Require tracer before any other modules
+require('./tracer');
+const Redis = require('ioredis');
+
+const redis = new Redis();
+
+async function main() {
+  try {
+    await redis.set('test', 'data');
+    await redis.get('test');
+    process.exit(0);
+  } catch (error) {
+    console.error(error);
+    process.exit(1);
+  }
+}
+
+main();

examples/ioredis/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "ioredis-example",
+  "private": true,
+  "version": "0.3.3",
+  "description": "Example of HTTP integration with OpenTelemetry",
+  "main": "index.js",
+  "scripts": {
+    "docker:start": "docker run -d -p 6379:6379 --name otjsredis redis:alpine",
+    "docker:stop": "docker stop otjsredis && docker rm otjsredis",
+    "start": "node index.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://[email protected]/open-telemetry/opentelemetry-js.git"
+  },
+  "keywords": [
+    "opentelemetry",
+    "redis",
+    "ioredis",
+    "tracing"
+  ],
+  "engines": {
+    "node": ">=8"
+  },
+  "author": "OpenTelemetry Authors",
+  "license": "Apache-2.0",
+  "bugs": {
+    "url": "https://github.com/open-telemetry/opentelemetry-js/issues"
+  },
+  "dependencies": {
+    "@opentelemetry/core": "^0.3.3",
+    "@opentelemetry/exporter-jaeger": "^0.3.3",
+    "@opentelemetry/exporter-zipkin": "^0.3.3",
+    "@opentelemetry/node": "^0.3.3",
+    "@opentelemetry/plugin-ioredis": "^0.3.3",
+    "@opentelemetry/tracing": "^0.3.3",
+    "ioredis": "^4.14.1"
+  },
+  "homepage": "https://github.com/open-telemetry/opentelemetry-js#readme",
+  "devDependencies": {
+    "cross-env": "^6.0.0"
+  }
+}

examples/ioredis/tracer.js

@@ -0,0 +1,29 @@
+'use strict';
+
+const opentelemetry = require('@opentelemetry/core');
+const { NodeTracer } = require('@opentelemetry/node');
+const { SimpleSpanProcessor } = require('@opentelemetry/tracing');
+const { JaegerExporter } = require('@opentelemetry/exporter-jaeger');
+const { ZipkinExporter } = require('@opentelemetry/exporter-zipkin');
+
+const EXPORTER = process.env.EXPORTER || '';
+
+const tracerRegistry = new NodeTracerRegistry();
+
+let exporter;
+if (EXPORTER.toLowerCase().startsWith('z')) {
+  exporter = new ZipkinExporter({
+    serviceName: 'ioredis-example',
+  });
+} else {
+  exporter = new JaegerExporter({
+    serviceName: 'ioredis-example',
+  });
+}
+
+tracer.addSpanProcessor(new SimpleSpanProcessor(exporter));
+
+// Initialize the OpenTelemetry APIs to use the BasicTracer bindings
+opentelemetry.initGlobalTracerRegistry(tracerRegistry);
+
+module.exports = opentelemetry.getTracer();