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 does not mention StackHashJsonProvider #506

Closed
will-sargent-eero opened this issue Mar 16, 2021 · 2 comments
Closed

Documentation does not mention StackHashJsonProvider #506

will-sargent-eero opened this issue Mar 16, 2021 · 2 comments
Milestone

Comments

@will-sargent-eero
Copy link

will-sargent-eero commented Mar 16, 2021

Describe the bug

StackHashJsonProvider is mentioned in the stack-hash document:

https://github.com/logstash/logstash-logback-encoder/blob/master/stack-hash.md#stackhashjsonprovider

but there is nominimal (the "more info") reference from the main documentation to stack-hash.md:

https://github.com/logstash/logstash-logback-encoder#customizing-stack-traces

So a user is not going to know that it's even possible to represent a stack hash as JSON by looking at the main README as there is no reference to it.

@philsttr
Copy link
Collaborator

philsttr commented Mar 16, 2021

There's a link to the stack hash document in

Where else would you recommend?

@will-sargent-eero
Copy link
Author

will-sargent-eero commented Mar 25, 2021

The link to the stack hash documents are fine in and of themselves, it's more a question of providing stackHash as a visible option in the documentation itself rather than referring to it by the class name.

So in https://github.com/logstash/logstash-logback-encoder#customizing-stack-traces it should be

"Computing and inlining hexadecimal hashes for each exception stack using inlineHash or stackHash provider (more info)"

and in https://github.com/logstash/logstash-logback-encoder/blob/master/stack-hash.md#stackhashjsonprovider mention that the XML element is stackHash specifically, and that it outputs the hash in JSON with "stash_hash" key.

@philsttr philsttr added this to the 7.0 milestone Nov 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants