[chore] [connector/spanmetrics] Better docs on high cardinality handling

[cyrille-leclerc]

Description

Better docs on high cardinality handling: explain how to modify instrumentation code to keep low cardinality and compliant span nmes while providing the desired context.

Link to tracking issue

Fixes

Testing

Documentation

[iblancasa]

Why was this removed?

[cyrille-leclerc]

I moved it below with 2 sections:

• Addressing high cardinality span names in the ingestion pipeline
• Addressing high cardinality span names in the instrumentation code

[iblancasa]

That let's the following paragraphs without making sense, I think

[iblancasa]

I don't feel this documentations should be added here but in a more general OpenTelemetry documentation like the website or something. We can point that documentation from here.

[cyrille-leclerc]

I do agree it would be better.
I couldn't find a good home for such docs:

• The Span Metrics Connector docs are this github page, see https://opentelemetry.io/docs/collector/components/connector/
• The languages section here may be the right top level section but we would probably want to create a subsection with instrumentation best practices.

I hope the OTel Blueprint initiative will create documentation that would be a great home for such content.

Do you have suggestions?

My mental model was to follow the mantra "Don't let perfection stand in the way of progress" and to start here.

[iblancasa]

I think you should go to https://github.com/open-telemetry/opentelemetry.io and create an issue there.