Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Export Metrics #68

Closed
1 task done
ewanharris opened this issue Jul 10, 2024 · 1 comment · Fixed by #69
Closed
1 task done

Export Metrics #68

ewanharris opened this issue Jul 10, 2024 · 1 comment · Fixed by #69
Assignees
@rhamzeh
Labels
enhancement New feature or request

Comments

@ewanharris
Copy link
Member

Checklist

Describe the problem you'd like to have solved

As a consumer of the SDK, I would like to hook it to my dashboards to get data on several metrics.

Describe the ideal solution

Integrate the OpenTelemetry .NET API package /~https://github.com/open-telemetry/opentelemetry-dotnet/blob/main/src/OpenTelemetry.Api/README.md

We need to be able to expose the metrics as outlined in the JS and Python SDKs

Alternatives and current workarounds

No response

References

No response

Additional context

No response
@ewanharris ewanharris added the enhancement New feature or request label Jul 10, 2024
@ewanharris ewanharris mentioned this issue Jul 10, 2024
Closed
6 tasks
@rhamzeh rhamzeh self-assigned this Jul 14, 2024
@rhamzeh rhamzeh moved this from Backlog to In progress in SDKs and Tooling Jul 14, 2024
@Hawxy
Copy link

Hawxy commented Jul 19, 2024

Worth mentioning that OTEL's HttpClient instrumentation already covers a handful of metrics you're looking at collecting:
/~https://github.com/open-telemetry/opentelemetry-dotnet-contrib/blob/main/src/OpenTelemetry.Instrumentation.Http/README.md

A number of these metrics are baked into .NET 8+ as well: https://learn.microsoft.com/en-us/dotnet/core/diagnostics/built-in-metrics-system-net

@rhamzeh rhamzeh mentioned this issue Jul 22, 2024
Merged
4 tasks
github-merge-queue bot pushed a commit that referenced this issue Sep 10, 2024
@rhamzeh
feat: add support for exporting metrics (#69)
ba3c108 
<!-- Thanks for opening a PR! Here are some quick tips:
If this is your first time contributing, [read our Contributing
Guidelines](/~https://github.com/openfga/.github/blob/main/CONTRIBUTING.md)
to learn how to create an acceptable PR for this repo.
By submitting a PR to this repository, you agree to the terms within the
[OpenFGA Code of
Conduct](/~https://github.com/openfga/.github/blob/main/CODE_OF_CONDUCT.md)

If your PR is under active development, please submit it as a "draft".
Once it's ready, open it up for review.
-->

<!-- Provide a brief summary of the changes -->

## Description

Introduces [OpenTelemetry](https://opentelemetry.io/) metrics reporting
into the SDK for specific actions. We're intentionally starting with
only a few metric events that we can then grow over time.

We don't have any formal documentation for this currently. We'll write
this as we roll it out across all SDKs, so here is a summary of the
events and the associated attributes:

## Metrics

### Supported Metrics

| Metric Name | Type | Enabled by Default | Description |

|---------------------------------|-----------|--------------------|--------------------------------------------------------------------------------------|
| `fga-client.request.duration` | Histogram | Yes | The total request
time for FGA requests |
| `fga-client.query.duration` | Histogram | Yes | The amount of time the
FGA server took to internally process nd evaluate the request |
|` fga-client.credentials.request`| Counter | Yes | The total number of
times a new token was requested when using ClientCredentials |
| `fga-client.request.count` | Counter | No | The total number of
requests made to the FGA server |

### Supported attributes

| Attribute Name | Type | Enabled by Default | Description |

|--------------------------------|----------|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `fga-client.response.model_id` | `string` | Yes | The authorization
model ID that the FGA server used |
| `fga-client.request.method` | `string` | Yes | The FGA method/action
that was performed (e.g. `Check`, `ListObjects`, ...) in TitleCase |
| `fga-client.request.store_id` | `string` | Yes | The store ID that was
sent as part of the request |
| `fga-client.request.model_id` | `string` | Yes | The authorization
model ID that was sent as part of the request, if any |
| `fga-client.request.client_id` | `string` | Yes | The client ID
associated with the request, if any |
| `fga-client.user` | `string` | No | The user that is associated with
the action of the request for check and list objects |
| `http.request.resend_count` | `int` | Yes | The number of retries
attempted (Only sent if the request was retried. Count of `1` means the
request was retried once in addition to the original request) |
| `http.response.status_code` | `int` | Yes | The status code of the
response |
| `http.request.method` | `string` | No | The HTTP method for the
request |
| `http.host` | `string` | Yes | Host identifier of the origin the
request was sent to |
| `url.scheme` | `string` | No | HTTP Scheme of the request
(`http`/`https`) |
| `url.full` | `string` | No | Full URL of the request |
| `user_agent.original` | `string` | Yes | User Agent used in the query
|

## Testing

Spin up Prometheus, build the project and then run the
OpenTelemetryExample app.

You should see metrics in Prometheus such as:
```
fga_client_query_duration_bucket{exported_instance="28790af8-2116-4e47-baaf-319f9f23f518", exported_job=""openfga-otel-dotnet-example"", fga_client_request_client_id="3DSvMhkJwjoSBMTliPEdPjybbVewfVes", fga_client_request_method="Check", fga_client_request_model_id="01J41WCA3KBA9SP2M350FPDEJ0", fga_client_request_store_id="01J40DW2J9NNYNNVEC430S3Z97", fga_client_response_model_id="01J41WCA3KBA9SP2M350FPDEJ0", fga_client_user="user:anne", http_client_request_duration="40", http_host="api.us1.fga.dev", http_request_method="POST", http_response_status_code="200", http_server_request_duration="2", instance="otel-collector:8889", job="otel-collector", label1="value1", le="5", url_full="https://api.us1.fga.dev/stores/01J40DW2J9NNYNNVEC430S3Z97/check", url_scheme="https", user_agent_original="openfga-sdk dotnet/0.4.0"}
---
fga_client_query_duration_bucket{exported_instance="fbee572d-0bff-4957-95a2-c532fe7312c1", exported_job=""openfga-otel-dotnet-example"", fga_client_request_client_id="3DSvMhkJwjoSBMTliPEdPjybbVewfVes", fga_client_request_method="WriteAuthorizationModel", fga_client_request_store_id="01J40DW2J9NNYNNVEC430S3Z97", http_client_request_duration="139", http_host="api.us1.fga.dev", http_request_method="POST", http_request_resend_count="1", http_response_status_code="201", http_server_request_duration="69", instance="otel-collector:8889", job="otel-collector", label1="value1", le="75", url_full="https://api.us1.fga.dev/stores/01J40DW2J9NNYNNVEC430S3Z97/authorization-models", url_scheme="https", user_agent_original="openfga-sdk dotnet/0.4.0"}
---
fga_client_query_duration_bucket{exported_instance="fbee572d-0bff-4957-95a2-c532fe7312c1", exported_job=""openfga-otel-dotnet-example"", fga_client_request_client_id="3DSvMhkJwjoSBMTliPEdPjybbVewfVes", fga_client_request_method="Write", fga_client_request_model_id="01J41WCA3KBA9SP2M350FPDEJ0", fga_client_request_store_id="01J40DW2J9NNYNNVEC430S3Z97", fga_client_response_model_id="01J41WCA3KBA9SP2M350FPDEJ0", http_client_request_duration="68", http_host="api.us1.fga.dev", http_request_method="POST", http_request_resend_count="1", http_response_status_code="200", http_server_request_duration="30", instance="otel-collector:8889", job="otel-collector", label1="value1", le="5000", url_full="https://api.us1.fga.dev/stores/01J40DW2J9NNYNNVEC430S3Z97/write", url_scheme="https", user_agent_original="openfga-sdk dotnet/0.4.0"}
```

Also for client credential exchange, you should see metrics such as:
```
{__name__="fga_client_credentials_request", exported_instance="28790af8-2116-4e47-baaf-319f9f23f518", exported_job=""openfga-otel-dotnet-example"", fga_client_request_client_id="3DSvMhkJwjoSBMTliPEdPjybbVewfVes", fga_client_request_method="ClientCredentialsExchange", http_client_request_duration="1461", http_host="fga.us.auth0.com", http_request_method="POST", http_response_status_code="200", instance="otel-collector:8889", job="otel-collector", label1="value1", url_full="https://fga.us.auth0.com/oauth/token", url_scheme="https", user_agent_original="openfga-sdk dotnet/0.4.0"}
```

## References
<!-- Provide a list of any applicable references here (GitHub Issue,
[OpenFGA RFC](/~https://github.com/openfga/rfcs), other PRs, etc..) -->

Closes #68

Follows the implementations in JS
(openfga/js-sdk#117), Python
(openfga/python-sdk#107) and Java
(openfga/java-sdk#94)

## Review Checklist
- [x] I have clicked on ["allow edits by
maintainers"](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork).
- [ ] I have added documentation for new/changed functionality in this
PR or in a PR to [openfga.dev](/~https://github.com/openfga/openfga.dev)
[Provide a link to any relevant PRs in the references section above]
- [x] 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
@github-project-automation github-project-automation bot moved this from In progress to Done in SDKs and Tooling Sep 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@rhamzeh rhamzeh

Labels
enhancement New feature or request
Projects
SDKs and Tooling
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: add support for exporting metrics openfga/dotnet-sdk
3 participants
@rhamzeh @Hawxy @ewanharris