open-telemetry
/
opentelemetry-dotnet
mirror of https://github.com/open-telemetry/opentelemetry-dotnet.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

clean up Jaeger doc structure (#849)

This commit is contained in:
Reiley Yang 2020-07-20 12:49:10 -07:00 committed by GitHub
parent 00ee600fc7
commit 5ad99f5110
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 32 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
src/OpenTelemetry.Exporter.Jaeger/README.md
View File

@ -1,20 +1,38 @@
# Jaeger Exporter for OpenTelemetry .NET
[![NuGet](https://img.shields.io/nuget/v/OpenTelemetry.Exporter.Jaeger.svg)](https://www.nuget.org/packages/OpenTelemetry.Exporter.Jaeger)
[![NuGet](https://img.shields.io/nuget/dt/OpenTelemetry.Exporter.Jaeger.svg)](https://www.nuget.org/packages/OpenTelemetry.Exporter.Jaeger)
The Jaeger exporter communicates to a Jaeger Agent through the compact thrift
protocol on the Compact Thrift API port. You can configure the Jaeger exporter
by following the directions below:
protocol on the Compact Thrift API port.
1. [Get Jaeger](https://www.jaegertracing.io/docs/1.13/getting-started/).
2. Configure the `JaegerExporter`
* `ServiceName`: The name of your application or service.
* `AgentHost`: Usually `localhost` since an agent should usually be running
on the same machine as your application or service.
* `AgentPort`: The compact thrift protocol port of the Jaeger Agent
(default `6831`)
* `MaxPacketSize`: The maximum size of each UDP packet that gets sent to
the agent. (default `65000`)
3. See the
[`TestJaegerExporter.cs`](../../samples/Exporters/Console/TestJaegerExporter.cs)
for an example of how to use the exporter.
## Prerequisite
* [Get Jaeger](https://www.jaegertracing.io/docs/1.13/getting-started/)
## Installation
```shell
dotnet add package OpenTelemetry.Exporter.Jaeger
```
## Configuration
You can configure the `JaegerExporter` by following the directions below:
* `ServiceName`: The name of your application or service.
* `AgentHost`: Usually `localhost` since an agent should usually be running on
the same machine as your application or service.
* `AgentPort`: The compact thrift protocol port of the Jaeger Agent (default
`6831`).
* `MaxPacketSize`: The maximum size of each UDP packet that gets sent to the
agent. (default `65000`).
See the
[`TestJaegerExporter.cs`](../../samples/Exporters/Console/TestJaegerExporter.cs)
for an example of how to use the exporter.
## References
* [Jaeger](https://www.jaegertracing.io)
* [OpenTelemetry Project](https://opentelemetry.io/)