http input ('in_http') does not document the useful and implemented `add_query_params` option

Open Beginner friendly
#434 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
85/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Domain
documentation

Research direction

Open the HTTP input documentation at https://docs.fluentd.org/input/http and compare its documented options with the implemented add_query_params behavior described in the issue. Document how to enable the option and how query parameters become record fields, then verify the page clearly explains the expected result.

Written by the indexing model from the issue text.

Description

enhancement good first issue
Describe the bug

the documentation of the http input plugin does not mention the add_query_params option, however, looking at the source code this option is implemented:
image

sending message to http://localhost:9880/mongo.my-new-inde444x3?el33iav=test555 will parse el33iav=test555 into "QUERY_EL33IAV":"test555" as a record as expected:
image

enabling the option add_query_params in the config works at worked at the latest td-agent and should be documented :

Link to the problematic documentation

https://docs.fluentd.org/input/http

Expected explanation

.

Additional context

No response

Dominant language
CSS
Stars
46
Forks
136
Avg merge
4h 47m
Merged PRs (30d)
16

Contributor guide

No contributing guide indexed for this repository

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.

More from fluent/fluentd-docs-gitbook

All issues in fluent/fluentd-docs-gitbook

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.