Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dulikvor/opentelemetry.exporter.azuremonitorlogs
A .NET OpenTelemetry exporter targeting Azure Monitor Logs.
https://github.com/dulikvor/opentelemetry.exporter.azuremonitorlogs
azure-log-analytics loganalytics opentelemetry telemetry
Last synced: about 1 month ago
JSON representation
A .NET OpenTelemetry exporter targeting Azure Monitor Logs.
- Host: GitHub
- URL: https://github.com/dulikvor/opentelemetry.exporter.azuremonitorlogs
- Owner: dulikvor
- License: mit
- Created: 2022-12-31T19:22:39.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-05-17T17:14:38.000Z (over 1 year ago)
- Last Synced: 2024-02-27T01:39:52.719Z (9 months ago)
- Topics: azure-log-analytics, loganalytics, opentelemetry, telemetry
- Language: C#
- Homepage:
- Size: 39.1 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Azure Monitor Logs OpenTelemetry Exporter
[](https://www.nuget.org/packages/AzureMonitorLogs.Exporter.OpenTelemetry)
## Supported .NET Versions:
Package is targeting .NET 7 and above.
## Background:
AzureMonitorLogs Exporter is an open-source project that provides a simple and efficient way to export telemetry data from your application to Azure Log Analytics.
The project is based on [open telemetry dotnet implementation](https://github.com/open-telemetry/opentelemetry-dotnet), adding a dedicated exporter targeting Log Analytics.
### Suported instrumentation
| Signal | Status |
| ------- | ---------- |
| Traces | Supported |
| Logs | Not supported |
| Metrics | Not supported |
### Supported protocols and main traits:
#### Data Collector api:
##### Requirements for usage:
* Azure log analytics Workspace is provisioned and known.
* Workspace immutable id.
* Workspace shared key, either primary or secondary.
* Exporter will target user specified custom log table, creating it on the fly, when required.
###### Important to note - It is recommended not to use an existing custom log table, in order to avoid data loss.
#### Ingestion api:
##### Requirements for usage:
* Azure log analytics Workspace is provisioned and known.
* Workspace immutable id.
* Application is provisioned and known, representing the to be instrumented service.
* Dcr and Dce.
* Application was granted the appropriate permission to Dcr.
* A log analytics custom log table was provisioned in advance, targeting open telemetry trace schema.
* Dcr stream definition depicting schema must match destination custom log table schema.
###### Important to note - [Ingestion api tutorial on how to set Application and Permissions](https://learn.microsoft.com/en-us/azure/azure-monitor/logs/tutorial-logs-ingestion-portal)
###### Expected custom log table schema:
| Column | Type |
| ------- | ---------- |
| TimeGenerated | datetime |
| Name | string |
| TraceId | string |
| TraceId | string |
| SpanId | string |
| ParentId | string |
| StartTime | datetime |
| EndTime | datetime |
| Attributes | dynamic |
### Getting started
#### Scope decleration:
```c#
using OpenTelemetry;
using OpenTelemetry.Exporter.AzureMonitorLogs;
using OpenTelemetry.Trace;
```
#### Data collector api:
##### Adding azure log analytics exporter:
```c#
using var tracerProvider = Sdk.CreateTracerProviderBuilder()
.AddAzureMonitorLogsExporter(o =>
{
o.WorkspaceId = //Workspace immutable id.
o.SharedKey = //workspace shared key, can be either primary or secondary.
o.TableName = //destination custom log table.
})
.Build();
```
#### Ingestion api:
##### Adding azure log analytics exporter:
```c#
using var tracerProvider = Sdk.CreateTracerProviderBuilder()
.AddAzureMonitorLogsExporter(o =>
{
o.WorkspaceId = //Workspace immutable id.
o.ClientId = //Application client id.
o.ClientSecret = //Application client secret.
o.TenantId = //AAD Tenant id.
o.AuthorityBaseUri = //AAD base url, for example - https://login.microsoftonline.com.
o.Audience = //Azure Resource Manager target audience, for example - https://monitor.azure.com/.default
o.DceUri = //dce uri, for example - https://yyyyyyy.{region}.ingest.monitor.azure.com
o.DcrImmutableId = //dcr immutable id, for example - dcr-yyyyxxxxaaaaazzzz00000
o.TableName = //destination custom log table.
})
.Build();
```
### Examples:
[Console application example](https://github.com/dulikvor/OpenTelemetry.Exporter.AzureMonitorLogs/tree/main/examples/Examples.Console)