Add telemetry for ProxySettingsPolicy #4388
Conversation
github-actions
bot
added
enhancement
| // GatewayAttachedProxySettingsPolicyCount is the number of relevant ProxySettingsPolicies | ||
| // attached at the Gateway level. | ||
| GatewayAttachedProxySettingsPolicyCount int64 | ||
| // RouteAttachedProxySettingsPolicyCount is the number of relevant ProxySettingsPolicies | ||
| // attached at the Route level. | ||
| RouteAttachedProxySettingsPolicyCount int64 |
There was a problem hiding this comment.
something to note that might make sense when you test later on, the order we send data over in data.avdl can't actually change. XCDF pipeline won't allow us to change the order, so all additions need to be appended, meaning you'll run into issues adding the count to this struct since its autogenerated. You'll need to add it outside of the struct like i do with inferencepoolCount.
There was a problem hiding this comment.
yeah, i've already noticed it here in unit tests.. was a bit strange to fix the order :D
So, you mean that order should be same as in the tests or as in the fields list here?
There was a problem hiding this comment.
The avdl file, needs to have its additional fields appended. Since that file is autogenerated, we'll need to add these new policy count fields to a different place so the autogenerated file is correct.
There was a problem hiding this comment.
so no changes needed? I just wanted to add 16, 17, but then noticed that 16 is used for inference and used 17, 18 instead.
There was a problem hiding this comment.
Sorry its a little confusing, but not quite. In the data.avdl file that is changed by this PR, we've added these two fields:
long? GatewayAttachedProxySettingsPolicyCount = null;
long? RouteAttachedProxySettingsPolicyCount = null;
However, these were added inbetween an existing: long? GatewayAttachedNpCount = null; and long? NginxPodCount = null;.
This disrupts the order and does not follow the rule set by the xcdf folks that when we change the avdl file, the additional fields have to be appended.
We'll need to find a way to add these new fields at the bottom of the auto-generated avdl file.
There was a problem hiding this comment.
i don't see how it can be done, if ProxySettingsPolicy is inside NGFResourceCount, and it is in the middle of the generated structure
Proposed changes
Problem: Need to track ProxySettingsPolicy telemetry
Solution:
add a product telemetry field to track the usage of ProxySettingsPolicy
update product telemetry doc with this new tracking information
Testing: unit tests.
TODO testing
Please focus on (optional): If you any specific areas where you would like reviewers to focus their attention or provide
specific feedback, add them here.
Closes #4304
Checklist
Before creating a PR, run through this checklist and mark each as complete.
Release notes