[docs] Agent configuration documentation #2366
Conversation
|
Needs documenting extra setting introduced in #2337 |
| ==== `agent.config.cache.expiration` | ||
|
|
||
| When using APM Agent configuration, information fetched from Kibana will be cached in memory. | ||
| This setting specifies the time before cache key expiration. Defaults to 30 seconds. |
There was a problem hiding this comment.
@graphaelli @simitt I don't know if we should document what this is used for:
-
if we don't, users might think that higher value is better and cause a negative effect (imagine them setting it to 1 day)
-
if we do, then we are documenting agent behaviour in the server and dictating how agents should behave:
The goal with Cache-Control was to enable agents to use it at their will or ignore it (the same as etag) - it was simply an attempt to return an appropriate response and provide mechanisms for optimization, should they want it.
Agents decided to use it as a poll interval for now. If we document that here, then we are forcing them to keep that behaviour, which was never my intention. They will not be able to replace their logic without introducing a breaking change.
bmorelli25
force-pushed
the
agent-config-kib-docs
branch
from
f7a9278 to
2795145
Compare
|
The docs-build ci will be red as this needs to be merged simultaneously with the Kibana changes. |
| @@ -0,0 +1,54 @@ | |||
| [[agent-configuration-api]] | |||
There was a problem hiding this comment.
@jalvz - Can you review this API documentation when you return from vacation?
Docs are live: https://www.elastic.co/guide/en/apm/server/master/setup-kibana-endpoint.html
Agent configuration documentation for elastic/apm#86.
Must be merged and backported simultaneously with elastic/kibana#40084.
Open questions:
What's the script to sync the yml files?Chat about theseapm-server.kibana.*config options -- not sure they're all correct.apm-server.kibana.*settings blacklisted/whitelisted?Figure out if we want to use the beatsGoing to use this for now. There are too many differences.configure-kibana-endpoint.asciidocfile or maintain our own.How will different/older server versions impact this?Backports