Document support for "URL as a source of metric data URLs"

Question

Document support for "URL as a source of metric data URLs"

otisg opened this issue 6 years ago · 5 comments

This is used in Spark and Couchbase integrations and may be used in other integrations in the future, so we should document how to do this.

Answer 1 · 2019-01-04T14:57:05.000Z

Actually, @bsmid , do we have that new how-to linked from anywhere? We should.

Answer 2 · 2019-01-04T15:02:16.000Z

We have, I linked to it from root sematext-agent-java README. You can see it in commit.

Answer 3 · 2019-01-04T15:06:31.000Z

Yeah, just saw it. Closing.

Answer 4 · 2019-01-04T15:11:16.000Z

Btw. wouldn't it make more sense (for the developer/reader) to have that info in https://github.com/sematext/sematext-agent-java/blob/master/docs/metrics-yaml-format.md ?
Doesn't the bottom of this doc already have similar sections (grouping, processing, extracting...)?

I'm asking because having this knowledge about how to handle metrics for integrations linked to only from the agent README would make it easy for people to miss this info.

Answer 5 · 2019-01-04T15:23:40.000Z

I am not sure, it seemed to me this is on different level of abstraction. Metrics YAML format is low-level, describes format itself plus those few a bit more advanced sections you mention. I have a feeling we might expand How-to guides with more advanced topics in the future, so this would be just the first addition. People looking into "how to do something" may not open metrics format doc. If you think it would be better to move, I am ok with that.