ash_graphql/documentation/topics/monitoring.md
Riccardo Binetti 513c1ac68f
improvement!: port AshGraphql to Ash 3.0 (#123)
Step 1: update Ash

Step 2: mass rename Api to Domain

Step 3: Ash.Query.expr -> Ash.Expr.expr

Also change ref interpolation

Step 4: remove all warnings

Step 5: remove registries from tests

Step 6: fix filter

Step 7: private? -> !public?

Step 8: Ash.Calculation -> Ash.Resource.Calculation

Step 9: use depend_on_resources/1 -> resources/1

Step 10: add Domain to all resources

Step 11: use Ash module for all actions

Step 12: add public? true all around

Step 13: remove verbose? from options passed during Domain calls

Step 14: add simple_sat

Step 15: Ash.ErrorKind is no more, so remove code from errors

Step 16: sprinkle default_accept :* around tests

Step 17: replace Ash.Changeset.new/2 with Ash.Changeset.for_*

Step 18: calculation fixups

- Context is now a struct and arguments go under the arguments key
- Function based calculations receive a list of records
- Add a select to query-based loads
- select -> load

Step 19: pass the correct name to pass the policy in tests

Step 20: Ash.Query.new/2 is no more

Step 21: add AshGraphql.Resource.embedded? utility function

Use that instead of Ash.Type.embedded_type?(resource_or_type) since resources
are not types anymore

Step 22: handle struct + instance_of: Resource in unions

Resources are not type anymore so they need to be passed this way in unions

Step 23: ensure we only check GraphQL actions for pagination

All reads are now paginated by default, so this triggered a compilation error

Step 24: swap arguments for sort on calculations

Step 25: remove unused debug? option
2024-04-01 14:03:06 -04:00

1.9 KiB

Monitoring

Please read the Ash monitoring guide for more information. Here we simply cover the additional traces & telemetry events that we publish from this extension.

A tracer can be configured in the domain. It will fallback to the global tracer configuration config :ash, :tracer, Tracer

graphql do
  trace MyApp.Tracer
end

Traces

Each graphql resolver, and batch resolution of the underlying data loader, will produce a span with an appropriate name. We also set a source: :graphql metadata if you want to filter them out or annotate them in some way.

Telemetry

AshGraphql emits the following telemetry events, suffixed with :start and :stop. Start events have system_time measurements, and stop events have system_time and duration measurements. All times will be in the native time unit.

  • [:ash, <domain_short_name>, :gql_mutation] - The execution of a mutation. Use resource_short_name and mutation (or action) metadata to break down measurements.

  • [:ash, <domain_short_name>, :gql_query] - The execution of a mutation. Use resource_short_name and query (or action) metadata to break down measurements.

  • [:ash, <domain_short_name>, :gql_relationship] - The resolution of a relationship. Use resource_short_name and relationship metadata to break down measurements.

  • [:ash, <domain_short_name>, :gql_calculation] - The resolution of a calculation. Use resource_short_name and calculation metadata to break down measurements.

  • [:ash, <domain_short_name>, :gql_relationship_batch] - The resolution of a batch of relationships by the data loader. Use resource_short_name and relationship metadata to break down measurements.

  • [:ash, <domain_short_name>, :gql_calculation_batch] - The resolution of a batch of calculations by the data loader. Use resource_short_name and calculation metadata to break down measurements.