Skip to content

Commit

Permalink
Added tracing to the configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
Andreas Hinz authored and Andy85de committed May 13, 2024
1 parent 1ebe05b commit 805cf83
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 7 deletions.
8 changes: 1 addition & 7 deletions docs/Installation/Configuration/Base Path.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,10 +81,4 @@ While writing this extension we could find no real use-case for **Option-3**.
- Redirects will always use `Base=/`

While we don't expect usage of **Option-4**, we can see scenarios where this configuration makes sense, so we added it to this extension.
Using `DiscardResponsePathBase` with any other setting did not produce usable results, so we chose to treat its use with other settings as an error.


## Tracing

Basic configuration requires you to set at least a service name. The service name will be displayed in the trace graph and used to correlate the logs
If you also provide an OtlpEndpoint URI the OtlpExporter will be setup to send traces via GRPC in the OTLP format to the provided endpoint
Using `DiscardResponsePathBase` with any other setting did not produce usable results, so we chose to treat its use with other settings as an error.
16 changes: 16 additions & 0 deletions docs/Installation/Configuration/Tracing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Tracing

Basic configuration requires you to set at least a `ServiceName`. The service name will be displayed in the trace graph and used to correlate the logs.
If you also provide an `OtlpEndpoint` URI the OtlpExporter will be setup to send traces via GRPC in the OTLP format to the provided endpoint.


An example of the trace configuration can resemble this:

```json
{
"Tracing": {
"OtlpEndpoint": "http://localhost:4317",
"ServiceName": "userprofile-service"
}
}
```

0 comments on commit 805cf83

Please sign in to comment.