fix: use oci.resourceName for OCIMYSQLDATABASE entity synthesis#3031
fix: use oci.resourceName for OCIMYSQLDATABASE entity synthesis#3031aprasad-sketch wants to merge 3 commits into
Conversation
The synthesis rule incorrectly referenced oci.resourceDisplayName which does not exist in the actual metric payload from oci-metric-streams. This caused entity synthesis to fail silently, resulting in entities with type NA in the GUID that never appear in the catalog. Changes: - definition.stg.yml: name field changed to oci.resourceName (matching other OCI entity definitions like autonomousdatabase and postgresql) - definition.stg.yml: goldenTags updated to only reference attributes that actually exist in metric data (oci.compartmentId, oci.region, oci.accountName) - tests/Metric.stg.json: updated to match real metric payload structure from oci-metric-streams collector Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
entityBot
left a comment
There was a problem hiding this comment.
We don't think these changes require an API Review Board (ARB) review, so it is not required to merge this PR. Note that all API changes do require one: if you believe this PR needs an ARB review, please create the ticket and add the ARB:pending label. Reach #api-review-board in case of doubts.
Keep the original goldenTags as-is — they don't break synthesis and will get populated when the collector starts sending those attributes from inventory/API sources. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
entityBot
left a comment
There was a problem hiding this comment.
We don't think these changes require an API Review Board (ARB) review, so it is not required to merge this PR. Note that all API changes do require one: if you believe this PR needs an ARB review, please create the ticket and add the ARB:pending label. Reach #api-review-board in case of doubts.
Rename .stg.yml/.stg.json files to .yml/.json to deploy the entity definition to production, enabling catalog visibility. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
entityBot
left a comment
There was a problem hiding this comment.
beep boop bop.
I have found some errors processing these changes:
- No valid, approved ARB ticket found in the PR description. This PR has to be reviewed by the API Review Board, please include a link to the ticket of that review in the PR description. Check how to start the process here or reach
#api-review-boardchannel in case of doubts
|
ARB ticket: https://new-relic.atlassian.net/browse/NR-577618 |
Summary
oci.resourceNameinstead of non-existentoci.resourceDisplayNamegoldenTagsto only reference attributes present in actual metric dataoci-metric-streamscollectorProblem
Entities of type
OCIMYSQLDATABASEare not appearing in the catalog page. The synthesis rule referencesoci.resourceDisplayNamefor the entity name, but the actual metric data fromoci-metric-streamsonly containsoci.resourceName. This causes entity synthesis to fail silently — the entity GUID encodes typeNAinstead ofOCIMYSQLDATABASE.Verified via OCI CLI and NRQL queries against account 10876283 (staging) that:
oci.resourceNameexists in all metric data points ✅oci.resourceDisplayNamedoes NOT exist ❌oci.availabilityDomain,oci.displayName,oci.lifecycleState,oci.subscriptionId,oci.mysqlVersion,oci.shapeNamedo NOT exist in metric data ❌ARB TICKET: https://new-relic.atlassian.net/browse/NR-577618
Fix
Aligned with existing OCI entity definitions (
infra-ociautonomousdatabase,infra-ocipostgresqldatabase) which correctly usename: oci.resourceName.Test plan
Metric.stg.jsonINFRA|OCIMYSQLDATABASEinstead ofINFRA|NAone.newrelic.com > All EntitiesValidation NRQL (post-deploy):
🤖 Generated with Claude Code