feat: enhancements to OpenTelemetry support

[evansims]

Description

⚠️ Breaking change ⚠️

This PR introduces enhancements to our OpenTelemetry metrics reporting support, migrating enhancements made to the Java, Go, and Python SDKs:

• OpenTelemetry functionality is now configurable using the TelemetryConfiguration and TelemetryMetricConfigurationclasses.
• FGA Method names are now title-cased, instead of camel-cased.
• Configuration has been updated to support the acceptance of a TelemetryConfiguration instance for configuring metrics reporting at runtime.
• Telemetry attributes and metric keys are now enums.
• Adds unit tests for full coverage of our OpenTelemetry support.

References

Review Checklist

• I have clicked on "allow edits by maintainers".
• I have added documentation for new/changed functionality in this PR or in a PR to openfga.dev [Provide a link to any relevant PRs in the references section above]
• The correct base branch is being used, if not main
• I have added tests to validate that the change in functionality is working as expected

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 88.95706% with 18 lines in your changes missing coverage. Please review.

Project coverage is 87.94%. Comparing base (09191e7) to head (be94b36).
Report is 57 commits behind head on main.

Files with missing lines	Patch %	Lines
api.ts	18.18%	0 Missing and 9 partials ⚠️
telemetry/configuration.ts	82.75%	2 Missing and 3 partials ⚠️
common.ts	88.88%	1 Missing and 1 partial ⚠️
telemetry/attributes.ts	96.15%	0 Missing and 2 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #149      +/-   ##
==========================================
- Coverage   91.22%   87.94%   -3.28%     
==========================================
  Files          19       23       +4     
  Lines        1003     1120     +117     
  Branches      133      171      +38     
==========================================
+ Hits          915      985      +70     
- Misses         82       83       +1     
- Partials        6       52      +46     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[rhamzeh]

Quick thoughts on this -

My major concern is the configuration as that would be a breaking change to change later.

If we can move the attrib and metric names to enums and make the configuration something like here https://github.com/openfga/dotnet-sdk/blob/main/OpenTelemetry.md, that would be great

Having the constructor as it is currently, take a set of true/false is problematic, b/c it's not easy for the user to tell what they are configuring and we could easily do a breaking change by changing the order without the user being aware.

Validation for the config would be great too to help users avoid typos

For the record, here's what the config looks like in .NET

TelemetryConfig telemetryConfig = new () {
    Metrics = new Dictionary<string, MetricConfig> {
        [TelemetryMeters.TokenExchangeCount] = new () {
            Attributes = new HashSet<string> {
                TelemetryAttribute.HttpScheme,
                TelemetryAttribute.HttpMethod,
                TelemetryAttribute.HttpHost,
                TelemetryAttribute.HttpStatus,
                TelemetryAttribute.HttpUserAgent,
                TelemetryAttribute.RequestMethod,
                TelemetryAttribute.RequestClientId,
                TelemetryAttribute.RequestStoreId,
                TelemetryAttribute.RequestModelId,
                TelemetryAttribute.RequestRetryCount,
                TelemetryAttribute.ResponseModelId
            }
        },
        [TelemetryMeters.QueryDuration] = new () {
            Attributes = new HashSet<string> {
                TelemetryAttribute.HttpStatus,
                TelemetryAttribute.HttpUserAgent,
                TelemetryAttribute.RequestMethod,
                TelemetryAttribute.RequestClientId,
                TelemetryAttribute.RequestStoreId,
                TelemetryAttribute.RequestModelId,
                TelemetryAttribute.RequestRetryCount,
            }
        },
        [TelemetryMeters.QueryDuration] = new () {
            Attributes = new HashSet<string> {
                TelemetryAttribute.HttpStatus,
                TelemetryAttribute.HttpUserAgent,
                TelemetryAttribute.RequestMethod,
                TelemetryAttribute.RequestClientId,
                TelemetryAttribute.RequestStoreId,
                TelemetryAttribute.RequestModelId,
                TelemetryAttribute.RequestRetryCount,
            }
        },
    }
};

var configuration = new ClientConfiguration() {
    ApiUrl = Environment.GetEnvironmentVariable("FGA_API_URL"),
    StoreId = Environment.GetEnvironmentVariable("FGA_STORE_ID"),
    AuthorizationModelId = Environment.GetEnvironmentVariable("FGA_MODEL_ID"),
    // Credentials = ... // If needed
    Telemetry = telemetryConfig
};

Sidenote: would be good to update up the docs and example too