docs: correct the default collector config apisix actually used for opentelemetry plugin #11247
Conversation
flea1lt
changed the title
|
@kayx23 PTAL |
There was a problem hiding this comment.
@shreemaan-abhishek please help review change in conf/config-default.yaml. I have checked that the updated values are indeed the default in the .lua file but have no context for why they were different in the very beginning.
The failing CI is FIPS and doesn't seem relevant.
conf/config-default.yaml
Outdated
| drop_on_queue_full: false # Drop spans when the export queue is full. | ||
| max_queue_size: 1024 # Set the maximum size of the span export queue. | ||
| batch_timeout: 2 # Set the timeout for span batches to wait in the export queue before | ||
| drop_on_queue_full: true # Drop spans when the export queue is full. |
There was a problem hiding this comment.
I don't understand why these default values need to change.
There was a problem hiding this comment.
Because the doc and the values in config-default.yaml are different, we need to align them by updating either the doc or the default config file.
The current apisix doc aligns its values with opentelemetry-lua, which is the dependency used by the plugin. Therefore, it may be preferable to correct the default configuration file.
There was a problem hiding this comment.
the default values in apisix config file would have been set considering APISIX's use cases. Updating the doc would be better also because existing users might already be relying on the default values, changing them would lead to another effort being required during version upgrade, no?
flea1lt
changed the title
Description
Fixes #11242
Checklist