OpenTelemetry instrumentation

[jose-lpa]

Hello,

Thank you guys for your time in putting together STAC FastAPI PgSTAC. It is such a good project, and we use it in our premises to serve geospatial data at scale, with success.

Over the last few months, we have been busy instrumenting our APIs, a lot of which are implemented using FastAPI, with OpenTelemetry. We used for this the official, open-source opentelemetry-instrumentation-fastapi package. It makes it quite easy and standard to instrument FastAPI applications, almost without adding code to the project.

Given the features this adds, from a systems management/administration perspective, I was wondering if you ever considered instrumenting stac-fastapi-pgstac, or if you will be keen to accept a pull request with this feature, which I would be happy to contribute. I was thinking of it as a feature that could be enabled via some environment variable(s), so these users who don't need or want it will not have to configure anything.

What are your thoughts on this?

Many thanks.

[hrodmn]

Hi @jose-lpa! Thanks for the feedback on your experience with stac-fastapi-pgstac. We would definitely welcome a PR for OpenTelemetry instrumentation in this project since many users seem to be using it these days.

For inspiration, we recently implemented the same thing over in titiler: developmentseed/titiler#1171. That feature got released with v0.23.1.

[jose-lpa]

Oh, that's fantastic, we use TiTiler too 😃 We will be updating that one for sure!

I will see if I can get some time over the next week to try to do something similar with stac-fastapi-pgstac.

[hrodmn]

Oh, that's fantastic, we use TiTiler too 😃 We will be updating that one for sure!

When you get around to upgrading TiTiler and have a chance to test out the OpenTelemetry implementation please file issues/PRs if there are changes you would want in the instrumentation that ships with titiler.core!