opensearch-project / opensearch-project/opensearch-java

[FEATURE] Document logging and tracing

Open
#535 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Java
Stars
165
Forks
250
Avg merge
1d 18h
Merged PRs (30d)
26

Description

Is your feature request related to a problem?

Coming from https://github.com/opensearch-project/opensearch-java/issues/533#issuecomment-1600946713 users have hard time configuring logging.

What solution would you like?

Add a logging/tracing section to user guide.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the user guide and the referenced OpenSearch issue comment to understand the logging configuration problem. Add a logging/tracing section that explains how users configure it, then verify that the guide clearly covers the reported difficulty.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.