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.

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

An introspective metadata endpoint #113

Open
CasperWA opened this issue Apr 7, 2022 · 1 comment · May be fixed by #125
Open

An introspective metadata endpoint #113

CasperWA opened this issue Apr 7, 2022 · 1 comment · May be fixed by #125
Assignees
Labels
changes_apispecs enhancement New feature or request

Comments

@CasperWA
Copy link
Contributor

CasperWA commented Apr 7, 2022

It would be great to have an introspective metadata endpoint, like /about or /info to retrieve all relevant metadata useful for debugging.
This could include:

  • OTEAPI-services version.
  • OTEAPI Core version.
  • List of installed OTEAPI plugins.
  • List of installed OTEAPI plugin versions.
  • List of endpoint paths/routes.
  • Full list of (non secret) configuration settings.
  • Redis instance information.
  • ...
@CasperWA CasperWA added enhancement New feature or request changes_apispecs labels Apr 7, 2022
@quaat
Copy link
Contributor

quaat commented Apr 7, 2022

Regarding exposing the metadata - we need to ensure this information should not be publicly available. Knowing which versions of dependent libraries are running can be useful info for people with harmful intents. If we create an admin/ -endpoint and encourage not to publicly expose it, we can use this for extracting metadata, statistics, etc...

@CasperWA CasperWA self-assigned this May 10, 2022
@CasperWA CasperWA linked a pull request May 10, 2022 that will close this issue
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changes_apispecs enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants