Skip to content

Commit

Permalink
Update monitoring.md
Browse files Browse the repository at this point in the history
Full mark-down for list and code block in local setup steps.
  • Loading branch information
YaphetKG authored Nov 29, 2023
1 parent bda52a7 commit df55e64
Showing 1 changed file with 12 additions and 13 deletions.
25 changes: 12 additions & 13 deletions docs/deployment-guide/monitoring.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,19 +25,18 @@ Logging outgoing requests bound to external services can be essential for captur
#### In a Development environment with no provisioned Jaeger instance, what is the best way to test my OTEL implementation?

To use a local Jaeger instance for testing your OpenTelemetry implementation, you can follow these general steps:
<ol>
<li> <strong>Install Jaeger:</strong> Download and install Jaeger locally. You can use Docker to quickly set up a Jaeger instance:
```bash
docker run -d --name jaeger -p 16686:16686 -p 6831:6831/udp jaegertracing/all-in-one:latest
```
This command pulls the latest Jaeger image and runs it, exposing the Jaeger UI on port 16686.
</li>
<li> <strong>Configure OpenTelemetry SDK:</strong> Use the OpenTelemetry SDK in your application to send traces to your local Jaeger instance. Configure your OpenTelemetry instrumentation to send data to localhost on the relevant Jaeger ports (usually 6831 for UDP and 16686 for HTTP).
</li>
<li><strong>Instrument Your Code:</strong> Instrument your application using OpenTelemetry APIs to create traces. Please make sure you've set up the instrumentation to export traces to your local Jaeger instance.
</li>
<li><strong>Verify Traces:</strong> Execute your application's workflows or requests that should generate traces. Then, access the Jaeger UI at http://localhost:16686 in your browser to view the traces generated by your application.</li>
</ol>

1. **Install Jaeger:** Download and install Jaeger locally. You can use Docker to quickly set up a Jaeger instance:
```bash
docker run -d --name jaeger -p 16686:16686 -p 6831:6831/udp jaegertracing/all-in-one:latest
```
This command pulls the latest Jaeger image and runs it, exposing the Jaeger UI on port 16686.
2. **Configure OpenTelemetry SDK:** Use the OpenTelemetry SDK in your application to send traces to your local Jaeger instance. Configure your OpenTelemetry instrumentation to send data to localhost on the relevant Jaeger ports (usually 6831 for UDP and 16686 for HTTP).

3. **Instrument Your Code:** Instrument your application using OpenTelemetry APIs to create traces. Please make sure you've set up the instrumentation to export traces to your local Jaeger instance.

4. **Verify Traces:** Execute your application's workflows or requests that should generate traces. Then, access the Jaeger UI at http://localhost:16686 in your browser to view the traces generated by your application.


Remember to adapt the OpenTelemetry SDK configuration in your code to use the address and ports where your local Jaeger instance is running.

Expand Down

0 comments on commit df55e64

Please sign in to comment.