Metrics endpoint described in openapi as returning json response

[avihaibd]

Default behavior when using documentation will show the /metrics endpoint in open-api autogenerated page as returning application/json

instrumentator.instrument(app).expose(app)

Result:

This can be resolved by using:

from starlette.responses import PlainTextResponse
instrumentator.instrument(app).expose(app, response_class=PlainTextResponse)

Another way of doint that would be:

from starlette.responses import Response
class PrometheusResponse(Response):
    media_type = prometheus_client.CONTENT_TYPE_LATEST

instrumentator.instrument(app).expose(app, response_class=PrometheusResponse)

Probably there are more ways to resolve, but I suggest that this would at least be included in docs.

[letmerecall]

Any idea on how we can customize the Example Value?

[letmerecall]

Any idea on how we can customize the Example Value?

Thanks, doing this for custom examples.

instrumentator.instrument(app).expose(
    app,
    response_class= PlainTextResponse,
    responses=
    {
        200: {
            "content":
                {
                    "text/plain": {
                        "example": '# Your sample response\n'
                                   '# Goes here'
                    },
                },
        },
    }
)