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

Documentation question: what are all the log topics? #514

Open
mackler opened this issue Apr 7, 2024 · 1 comment
Open

Documentation question: what are all the log topics? #514

mackler opened this issue Apr 7, 2024 · 1 comment

Comments

@mackler
Copy link

mackler commented Apr 7, 2024

Hi, sorry if this is the wrong place to ask this (I can't seem to get onto the slack channel without having an arango email).

On the documentation page "Log levels" it says:

For each log topic (authentication, cluster, queries, etc.), you can configure the lowest level to log.

The documentation says there are log topics, and it identifies three of them and indicates there are others. But the documentation neither indicates what those other topics are, nor provides any reference to a place where a comprehensive list of log topics can be accessed. I've tried internet searching and also the "AI" chatbot on the documentation site, with no success.

Is there a complete list of ArangoDB log topics it in the documentation? If so, I suggest including a link to it on the "Log levels" page. If not, I suggest considering whether adding that information might potentially be a net benefit for readers who want to know what the etc in “authentication, cluster, queries, etc.” above refers to.

@Simran-B Simran-B transferred this issue from arangodb/arangodb Apr 9, 2024
@Simran-B
Copy link
Contributor

Simran-B commented Apr 9, 2024

The description of the --log.level startup option has a list of log topics, which you can access with arangod --help-log and also see here: https://docs.arangodb.com/stable/components/arangodb-server/options/#--loglevel

You can also find a list in the HTTP API docs, but unfortunately without proper descriptions - for each log message, a topic is set by an engineer, but there is some leeway and ambiguity which makes it difficult to capture what topic is used when:
https://docs.arangodb.com/stable/components/arangodb-server/options/#--loglevel

Adding a link as you suggest to either of the above pieces of content is a good suggestion, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants