opensearch-project / opensearch-project/data-prepper
Attribute `index_type` of `opensearch` in `sink` lacks further explanation
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 374
- Forks
- 354
- Avg merge
- 3d 18h
- Merged PRs (30d)
- 8
Description
Is your feature request related to a problem? Please describe.
A clear and concise description of what the problem is. Ex. It would be nice to have [...]
- No.
Describe the solution you'd like
A clear and concise description of what you want to happen.
- Attribute
index_typeofopensearchinsinklacks further explanation. See https://opensearch.org/docs/latest/data-prepper/pipelines/configuration/sinks/opensearch/#configuration-options .
Tells the sink plugin what type of data it is handling. Valid values are
custom,trace-analytics-raw,trace-analytics-service-map, ormanagement-disabled. Default iscustom.
-
This brings up a question: what are the functions of
custom,trace-analytics-raw,trace-analytics-service-mapandmanagement-disabled? I can't find any documentation explaining them. -
-
I hope the documentation can add some explanation.
Describe alternatives you've considered (Optional)
A clear and concise description of any alternative solutions or features you've considered.
- Null.
Additional context
Add any other context or screenshots about the feature request here.
- Null.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the OpenSearch documentation page linked in the issue and trace the configuration-options entry for index_type back to the repository's documentation source. Explain the purposes of custom, trace-analytics-raw, trace-analytics-service-map, and management-disabled, then verify the rendered page presents these explanations clearly.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100