-
Notifications
You must be signed in to change notification settings - Fork 1.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
expand upon example of using an index as a metric_tag #12438
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A couple of style changes and then this should be good to go
Co-authored-by: Heston Hoffman <[email protected]>
Co-authored-by: Heston Hoffman <[email protected]>
Co-authored-by: Heston Hoffman <[email protected]>
Hey @hestonhoffman thanks for the review! I just merged all of your suggestions when you have a chance to take a another look |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this PR, this is very helpful!
Co-authored-by: Florian Veaux <[email protected]>
The value corresponding to the `accDnForwardFilterDest` of a row in this table will be found at the following OID: `.1.3.6.1.4.1.5.1.1.19.25.1.1.<accDnForwardFilterDest>`. Retrieving the value of `.1.3.6.1.4.1.5.1.1.19.25.1.1.123` will return `123`. To capture the value `123` and apply it as a metric tag, target `index: 1`. | ||
|
||
The value corresponding to the `accDnForwardFilterSource` of a row in this table will be found at the following OID: `.1.3.6.1.4.1.5.1.1.19.25.1.1.<accDnForwardFilterDest>.<accDnForwardFilterSource>`. Retrieving the value of `.1.3.6.1.4.1.5.1.1.19.25.1.1.123.456` will return `456`. To capture the value `456` and apply it as a metric tag, target `index: 2`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it could more clear to illustrate with an example like this one:
metrics:
- MIB: CISCO-FIREWALL-MIB
table:
OID: 1.3.6.1.4.1.9.9.147.1.2.2.2
name: cfwConnectionStatTable
symbols:
- OID: 1.3.6.1.4.1.9.9.147.1.2.2.2.1.5
name: cfwConnectionStatValue
metric_tags:
- index: 1 // capture first index digit
tag: service_type
- index: 2 // capture second index digit
tag: stat_type
from a real example here
- MIB: CISCO-FIREWALL-MIB | |
table: | |
OID: 1.3.6.1.4.1.9.9.147.1.2.2.2 | |
name: cfwConnectionStatTable | |
symbols: | |
- OID: 1.3.6.1.4.1.9.9.147.1.2.2.2.1.5 | |
name: cfwConnectionStatValue | |
metric_tags: | |
- index: 1 | |
tag: service_type | |
- index: 2 | |
tag: stat_type |
For example, when we fetch the value of cfwConnectionStatValue
, the OID with the index is like 1.3.6.1.4.1.9.9.147.1.2.2.2.1.5.20.2 = 4087850099
, here the indexes are 20.2
(1.3.6.1.4.1.9.9.147.1.2.2.2.1.5.<service type>.<stat type>
).
cfwConnectionStatEntry OBJECT-TYPE
SYNTAX CfwConnectionStatEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry in the table, containing information about a
firewall statistic."
INDEX { cfwConnectionStatService, cfwConnectionStatType }
::= { cfwConnectionStatTable 1 }
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good, thanks @AlexandreYang, pushed up a commit with these updates: 192ff22
Let me know what you think!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
awesome -- sure thing! One more thing here @AlexandreYang it looks like I am not authorized to merge this PR - would you be able to do so on or point me in the right direction for how I can obtain authorization? Screenshot showing Merging is blocked
auth message
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice ! thanks a lot for improving the doc :)
Co-authored-by: Heston Hoffman <[email protected]> Co-authored-by: Florian Veaux <[email protected]> 2c3040f
What does this PR do?
Expands on our current documentation surrounding applying the index of an OID as a metric tag. Adds additional detail regarding the syntax of metric collection from a table.
Motivation
conversation with customer on this ticket and ENG on this thread
Additional Notes
Review checklist (to be filled by reviewers)
changelog/
andintegration/
labels attached