Create EXAMPLES.md #63
Conversation
Add examples how to use the Fortigate Exporter
Hm, will we have many more? I'd say we do not create a docs/ for now but I am 100% with you to move it if we end up having a website or something. |
|
Ready for review. Had a friend (thanks @ventris) look over it quite quickly as well to see that it reads OK. |
EXAMPLES.md
Outdated
| # PromQL usage examples for Fortigate Exporter | ||
|
|
||
| PromQL is an advanced language and proper usage of it requires one to both understand | ||
| the language itself and how the metrics one has are constructed. |
There was a problem hiding this comment.
English is my second language so could be me, but that sounds kinda weird.
WDYT about PromQL is an advanced language and proper usage of it requires first to understand the language itself and how the metrics one are constructed.
There was a problem hiding this comment.
Yeah, it is a hard sentence to grok. What do you think of this new one?
There was a problem hiding this comment.
What are trying to bring across with organized? I'm not sure what you mean here
There was a problem hiding this comment.
I want to state that even if you are the world's best champion on PromQL, you still need to learn how each exporter works; as in what metrics are available to you, and how their labels associate between the metrics.
E.g. that we have a fortigate_version_info that can be used to get the build info (as opposed to adding the build label to all metrics, as another exporter might have had done).
Co-authored-by: Sebastian Poxhofer <secustor@users.noreply.github.com>
|
🎉 This PR is included in version 1.1.0 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
Add examples how to use the Fortigate Exporter
Fixes #39 but of course more examples will be added over time.