Add information about Open Telemetry

qdraw · Jan 8, 2024 · 30661af · 30661af
1 parent 30d87ca
commit 30661af
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 0 deletions.
diff --git a/documentation/docs/developer-guide/logging/opentelemetry.md b/documentation/docs/developer-guide/logging/opentelemetry.md
@@ -0,0 +1,10 @@
+# Open Telemetry logging
+
+
+```
+"app__OpenTelemetry__TracesEndpoint": "https://otlp.eu01.nr-data.net:4318/v1/traces",
+"app__OpenTelemetry__MetricsEndpoint": "https://otlp.eu01.nr-data.net:4318/v1/metrics",
+"app__OpenTelemetry__LogsEndpoint": "https://otlp.eu01.nr-data.net:4318/v1/logs",
+"app__OpenTelemetry__Header": "api-key=EXAMPLE_KEY",
+"app__OpenTelemetry__ServiceName": "starsky-dev",
+```
diff --git a/documentation/docs/developer-guide/logging/readme.md b/documentation/docs/developer-guide/logging/readme.md
@@ -4,6 +4,9 @@ sidebar_position: 20
 
 # Logging
 
+## Open Telemetry logging
+See [Open Telemetry logging](opentelemetry.md)
+
 ## Desktop logs
 
 For the desktop app the logs are stored in following location:

diff --git a/starsky/starsky/readme.md b/starsky/starsky/readme.md
@@ -92,6 +92,8 @@ You could use machine specific configuration files: appsettings.machinename.json
 36. `GeoFilesSkipDownloadOnStartup` Skip download of GeoFiles on startup, _recommend to keep this false or null_ - _default false_
 37. `ExiftoolSkipDownloadOnStartup` Skip download of Exiftool on startup, _recommend to keep this false or null_ - _default false_
 38. `AccountRolesByEmailRegisterOverwrite` Overwrite the default role for a user by email address, _default empty list_
+39. `OpenTelemetry` See logging in an external service, _default no enabled_ see [OpenTelemetry](https://docs.qdraw.nl/docs/developer-guide/logging/opentelemetry.md)
+
 
 ### Appsettings.json example
 ```json

diff --git a/starsky/telemetry.md b/starsky/telemetry.md
@@ -121,3 +121,7 @@ You may re-enable telemetry if you'd like to re-join the program by running the
 
 `app__EnablePackageTelemetry=true`
 
+## OpenTelemetry
+
+By default OpenTelemetry is disabled to collect telemetry data.
+But you can setup your own provider to collect information