How to use this library for sending metrics to AppInsights? - Githubissues

frigus02 / opentelemetry-application-insights

OpenTelemetry exporter for Azure Application Insights

MIT License

22 stars 12 forks source link

How to use this library for sending metrics to AppInsights? #39

Closed govenkat-ms closed 3 years ago

govenkat-ms commented 3 years ago

Can this library be used for sending metrics to AppInsights?

Thanks

frigus02 commented 3 years ago

Hi there. No, metrics are not supported, yet. I think this would be great to add, though. Do you happen to know if there is API documentation about metrics in AppInsights?

frigus02 commented 3 years ago

Okay, I think the API for traces also supports metrics. It's just a different data model.

Sadly, it looks like neither the official Python (source) nor JavaScript (source) exporters support metrics. This means we need to figure out the mapping from OpenTelemetry model to AppInsights model ourselves.

If I see this correctly, this is the AppInsights model (swagger):

{
  "name": "Microsoft.ApplicationInsights.Metric",
  "time": "2009-06-15T13:45:30.0000000Z",
  "data": {
    "baseType": "MetricsData",
    "baseData": {
      "metrics": [
        {
          "ver": 2,
          "ns": "something",
          "name": "banana",
          "value": 4.2,
          "kind": "Measurement OR Aggregation",
          "count": 2,
          "min": 1.0,
          "max": 10.0,
          "stdDev": 0.5
        }
      ],
      "properties": {}
    }
  }
}

frigus02 commented 3 years ago

Looks like there is also another API for metrics called "Azure Metrics":

This is looks harder to use because of the OAuth authentication.

I don't have any experience using metrics in AppInsights. Do you know which one is preferred right now, @govenkat-ms?

frigus02 commented 3 years ago

If we would implement this based on the AppInsights API, we would need to map whatever the different aggregators give us to the MetricsData model.

ArrayAggregator: probably a list of "Measurement" metrics each with just a value
LastValueAggregator: probably just a single "Measurement" metric with just a value
MinMaxSumCountAggregator: a single "Aggregation" metric with min, max, count and value=(sum/count)
DdSketchAggregator: same as MinMaxSumCountAggregator
SumAggregator: a single "Aggregation" metric with value=sum
HistogramAggregator: could report a single "Aggregation" metric with count and value=(sum/count). Not sure how to encode the buckets, though. Maybe just ignore them?

I imagine this list is likely subject to change as the OpenTelemetry metrics API finalizes and the Rust implementation catches up. But kinds of aggregations should not change drastically.

govenkat-ms commented 3 years ago

I don't believe there's a preference to either the docs or the swagger.

frigus02 commented 3 years ago

I have an intial implementation of metrics, which seems to be working. Still needs some more testing of the different aggregation types but this looks promising.

frigus02 commented 3 years ago

Sorry this took so long. I couldn't find the time to finish this.

Anyway. Metrics support is now in and released in version 0.18.0. The API to setup the exporter is still a bit rough. But I think that can be improved in the future.