Add observability to STAC, Raster APIs

Open
#193 5 comments 0 reactions 1 assignee View on GitHub

Nobody has claimed this yet.

Assessment

This issue has not been assessed yet.

Description

Feature Request
Problem description

Some partners may need usage metrics from the STAC or Raster API to assess most access collections, items etc. This could be be achieved by instrumenting the APIs to emit metrics, traces and logs. Observability data can then be visualized or analyzed in Cloudwatch or Grafana.

The VEDA Data Services team has implemented STAC and Raster Observability to get fine grained analytics in Grafana that can tell us the most accessed collections using the /collections/{collection_id} endpoint for example. Metrics could also be obtained for Raster endpoints.

See the VEDA implementation in the STAC API for more details: https://github.com/NASA-IMPACT/veda-backend/blob/develop/stac_api/runtime/src/monitoring.py

A potential feature implementation would instrument the APIs using OpenTelemetry or AWS Lambda Powertools. Grafana could also be be deployed as part of the infrastructure however this could be left to individual implementors as well.

Dominant language
Shell
Stars
330
Forks
33
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from developmentseed/eoAPI

All issues in developmentseed/eoAPI

Similar issues

More Shell/Bash issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.