Skip to content
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

docs(NR-290692): add clarifying verbiage on how markers are included on NRQL charts #19391

Draft
wants to merge 3 commits into
base: develop
Choose a base branch
from
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 45 additions & 0 deletions src/content/docs/change-tracking/change-tracking-view-analyze.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,51 @@
<Callout variant="tip">
If you land on a dashboard or entity summary page and don't see the tracked change you're expecting, check your time picker selection. It might be outside the window you are looking at.
</Callout>

* If you are still not seeing the markers that you're expecting, please verify whether you have added those change events to the entities relevant to the chart. Most charts are driven by a NRQL query that you can see by clicking on the three-dots at the tile's top-right corner. The entities relevant to the chart are derived from the NRQL query based on the following logic:

Check warning on line 37 in src/content/docs/change-tracking/change-tracking-view-analyze.mdx

View workflow job for this annotation

GitHub Actions / vale-linter

[vale] reported by reviewdog 🐶 [Microsoft.Passive] 'are driven' looks like passive voice. Raw Output: {"message": "[Microsoft.Passive] 'are driven' looks like passive voice.", "location": {"path": "src/content/docs/change-tracking/change-tracking-view-analyze.mdx", "range": {"start": {"line": 37, "column": 176}}}, "severity": "INFO"}

Check warning on line 37 in src/content/docs/change-tracking/change-tracking-view-analyze.mdx

View workflow job for this annotation

GitHub Actions / vale-linter

[vale] reported by reviewdog 🐶 [Microsoft.Passive] 'are derived' looks like passive voice. Raw Output: {"message": "[Microsoft.Passive] 'are derived' looks like passive voice.", "location": {"path": "src/content/docs/change-tracking/change-tracking-view-analyze.mdx", "range": {"start": {"line": 37, "column": 317}}}, "severity": "INFO"}
* Entities that are directly specified in the query for the chart using either an `IN` or `=` operator (e.g. queries with an `WHERE entity.guid IN ('MTE2NjAxMzJ8QVBNfEFQUExJQ0FUSU9OfDEyMDk1MjY5')` clause). While we use `entity.guid` as an example, other properties may also be used to explicitly designate entities for the query. They are:

Check failure on line 38 in src/content/docs/change-tracking/change-tracking-view-analyze.mdx

View workflow job for this annotation

GitHub Actions / vale-linter

[vale] reported by reviewdog 🐶 [Microsoft.Foreign] Use 'for example' instead of 'e.g.'. Raw Output: {"message": "[Microsoft.Foreign] Use 'for example' instead of 'e.g.'.", "location": {"path": "src/content/docs/change-tracking/change-tracking-view-analyze.mdx", "range": {"start": {"line": 38, "column": 109}}}, "severity": "ERROR"}

Check warning on line 38 in src/content/docs/change-tracking/change-tracking-view-analyze.mdx

View workflow job for this annotation

GitHub Actions / vale-linter

[vale] reported by reviewdog 🐶 [Microsoft.Passive] 'be used' looks like passive voice. Raw Output: {"message": "[Microsoft.Passive] 'be used' looks like passive voice.", "location": {"path": "src/content/docs/change-tracking/change-tracking-view-analyze.mdx", "range": {"start": {"line": 38, "column": 279}}}, "severity": "INFO"}

Check warning on line 38 in src/content/docs/change-tracking/change-tracking-view-analyze.mdx

View workflow job for this annotation

GitHub Actions / vale-linter

[vale] reported by reviewdog 🐶 [new-relic.ComplexWords] Consider using 'choose' instead of 'designate'. Raw Output: {"message": "[new-relic.ComplexWords] Consider using 'choose' instead of 'designate'.", "location": {"path": "src/content/docs/change-tracking/change-tracking-view-analyze.mdx", "range": {"start": {"line": 38, "column": 301}}}, "severity": "INFO"}

Check failure on line 38 in src/content/docs/change-tracking/change-tracking-view-analyze.mdx

View workflow job for this annotation

GitHub Actions / vale-linter

[vale] reported by reviewdog 🐶 [Microsoft.Contractions] Use 'they're' instead of 'They are'. Raw Output: {"message": "[Microsoft.Contractions] Use 'they're' instead of 'They are'.", "location": {"path": "src/content/docs/change-tracking/change-tracking-view-analyze.mdx", "range": {"start": {"line": 38, "column": 335}}}, "severity": "ERROR"}
* `entity.guid`
* `entityGuid`
* `entity.name`
* `entityName`
* `appName`
* `service.name`
* Entities that are [related](https://docs.newrelic.com/docs/new-relic-solutions/new-relic-one/core-concepts/what-entity-new-relic/#related-entities) to entities specified via the method above. Only the following relationship-types are considered:

Check warning on line 45 in src/content/docs/change-tracking/change-tracking-view-analyze.mdx

View workflow job for this annotation

GitHub Actions / vale-linter

[vale] reported by reviewdog 🐶 [Microsoft.Passive] 'are related' looks like passive voice. Raw Output: {"message": "[Microsoft.Passive] 'are related' looks like passive voice.", "location": {"path": "src/content/docs/change-tracking/change-tracking-view-analyze.mdx", "range": {"start": {"line": 45, "column": 1}}}, "severity": "INFO"}

Check warning on line 45 in src/content/docs/change-tracking/change-tracking-view-analyze.mdx

View workflow job for this annotation

GitHub Actions / vale-linter

[vale] reported by reviewdog 🐶 [Microsoft.Passive] 'are considered' looks like passive voice. Raw Output: {"message": "[Microsoft.Passive] 'are considered' looks like passive voice.", "location": {"path": "src/content/docs/change-tracking/change-tracking-view-analyze.mdx", "range": {"start": {"line": 45, "column": 237}}}, "severity": "INFO"}
* `CALLS`
* `SERVES`
* `IS`
* `CONTAINS`
* `HOSTS`

Please be advised that __NRQL queries for charts are currently scoped to a single account__. This means that if you specify entity-GUIDs belonging to multiple accounts, only markers from a single account will be visualized.

Check warning on line 52 in src/content/docs/change-tracking/change-tracking-view-analyze.mdx

View workflow job for this annotation

GitHub Actions / vale-linter

[vale] reported by reviewdog 🐶 [Microsoft.Passive] 'be advised' looks like passive voice. Raw Output: {"message": "[Microsoft.Passive] 'be advised' looks like passive voice.", "location": {"path": "src/content/docs/change-tracking/change-tracking-view-analyze.mdx", "range": {"start": {"line": 52, "column": 10}}}, "severity": "INFO"}

Check warning on line 52 in src/content/docs/change-tracking/change-tracking-view-analyze.mdx

View workflow job for this annotation

GitHub Actions / vale-linter

[vale] reported by reviewdog 🐶 [new-relic.ComplexWords] Consider using 'many' instead of 'multiple'. Raw Output: {"message": "[new-relic.ComplexWords] Consider using 'many' instead of 'multiple'.", "location": {"path": "src/content/docs/change-tracking/change-tracking-view-analyze.mdx", "range": {"start": {"line": 52, "column": 153}}}, "severity": "INFO"}

Check warning on line 52 in src/content/docs/change-tracking/change-tracking-view-analyze.mdx

View workflow job for this annotation

GitHub Actions / vale-linter

[vale] reported by reviewdog 🐶 [Microsoft.Passive] 'be visualized' looks like passive voice. Raw Output: {"message": "[Microsoft.Passive] 'be visualized' looks like passive voice.", "location": {"path": "src/content/docs/change-tracking/change-tracking-view-analyze.mdx", "range": {"start": {"line": 52, "column": 212}}}, "severity": "INFO"}

For example, let's say that the query for your chart looks like the following:
```
FROM Transaction SELECT count(*) WHERE entityGuid IN ('MTE2NjAxMzJ8QVBNfEFQUExJQ0FUSU9OfDg0MTY1OTI','MTEwNjI2OTl8QVBNfEFQUExJQ0FUSU9OfDg5ODEwMDk5') TIMESERIES MAX SINCE 2 weeks AGO
```
Markers from both entities will show up on the chart. Additionally, markers from related-entities will also be included on the chart. To determine the list of related-entities, you can run a GraphQL query similar to the example below:

Check warning on line 58 in src/content/docs/change-tracking/change-tracking-view-analyze.mdx

View workflow job for this annotation

GitHub Actions / vale-linter

[vale] reported by reviewdog 🐶 [Microsoft.Passive] 'be included' looks like passive voice. Raw Output: {"message": "[Microsoft.Passive] 'be included' looks like passive voice.", "location": {"path": "src/content/docs/change-tracking/change-tracking-view-analyze.mdx", "range": {"start": {"line": 58, "column": 111}}}, "severity": "INFO"}
```
{
actor {
entity(guid: "MTEwNjI2OTl8QVBNfEFQUExJQ0FUSU9OfDg5ODEwMDk5") {
relatedEntities(
filter: {relationshipTypes: {include: [CALLS, SERVES, IS, CONTAINS, HOSTS]}}
) {
results {
type
source {
guid
}
target {
guid
}
}
}
}
}
}
```

* <DNT>**Entity sidebar:**</DNT> To see a table of changes, click on <DNT>**Change tracking**</DNT> for any entity that has recorded changes. It features a time range selector and table filtering and sorting options. Use these to narrow the field of changes or to find a specific change.
<Callout variant="tip">Note that you may need to adjust the selected time range on this page to see tracked changes. Also, by default the table will only lazy load up to 2,000 changes. Keep this in mind as you're filtering, searching, and adjusting your time range.</Callout>
* <DNT>**New Relic <InlinePopover type="alerts"/> & Detection:**</DNT> If your change is related to an issue, you'll see it listed in the <DNT>**Root Cause Analysis**</DNT> section of the <DNT>**Issues**</DNT> page.
Expand Down
Loading