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.

Sign up for GitHub

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

Jump to bottom

feat(query builder): New data explorer #18907

Merged
merged 9 commits into from
Oct 16, 2024
Merged

feat(query builder): New data explorer #18907

merged 9 commits into from
Oct 16, 2024

Conversation

cbehera-newrelic
Copy link
Contributor

  • Ticket: NR-316996

@cbehera-newrelic cbehera-newrelic added content requests related to docs site content from_tw Identifies issues/PRs from Tech Docs writers labels Oct 9, 2024
@cbehera-newrelic cbehera-newrelic self-assigned this Oct 9, 2024
@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 9, 2024

Hi @cbehera-newrelic 👋

Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days.

We will automatically generate a preview of your request, and will comment with a link when the preview is ready (usually 10 to 20 minutes).

@netlify Netlify
Copy link

netlify bot commented Oct 9, 2024 •
edited
Loading

✅ Deploy Preview for docs-website-netlify ready!

Name Link
🔨 Latest commit 0513e16
🔍 Latest deploy log https://app.netlify.com/sites/docs-website-netlify/deploys/670fe8d9cc43e400080746c1
😎 Deploy Preview https://deploy-preview-18907--docs-website-netlify.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 9, 2024

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).

@github-actions GitHub Actions
Copy link

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).

@cbehera-newrelic cbehera-newrelic marked this pull request as ready for review October 10, 2024 10:00
@github-actions GitHub Actions
Copy link

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).

@akristen
Copy link
Contributor

Hi @cbehera-newrelic! Is this ready for review? I'm seeing a couple things:

Let's set up time next week to talk about your updates!

akristen
akristen reviewed Oct 14, 2024
View reviewed changes
...ent/docs/query-your-data/explore-query-data/query-builder/introduction-new-data-explorer.mdx Outdated
Need to perform a more detailed search? Read how to [query your data](/docs/query-your-data/explore-query-data/get-started/introduction-querying-new-relic-data/). If you haven't already, create your free New Relic account to start monitoring your data today.


## Why It Matters [#why-it-matters]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Why It Matters [#why-it-matters]
## Understand query your data [#understand-query-buildler]

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think "why it matters" can be something people read by really quickly because it's more conceptual. this is a suggestion, but it's not a blocker :)

akristen
akristen reviewed Oct 14, 2024
View reviewed changes
...ent/docs/query-your-data/explore-query-data/query-builder/introduction-new-data-explorer.mdx

Do you research the state of your systems? Do you need to plan resources, identify and respond to incidents, or troubleshoot faulty behaviors? The data explorer makes it easy to identify, fetch and visualize the data you are looking for through visual menus, without ever using NRQL or building queries.

With the <DNT>**data explorer**</DNT>, you can access all data stored in the New Relic database (NRDB) in a quick, intuitive way. You can then select facet your queries using the attributes and filter down to the needed value.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it called "data explorer" or "Query your data"?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's called data explorer.

akristen
akristen reviewed Oct 14, 2024
View reviewed changes
...ent/docs/query-your-data/explore-query-data/query-builder/introduction-new-data-explorer.mdx Outdated

With the <DNT>**data explorer**</DNT>, you can access all data stored in the New Relic database (NRDB) in a quick, intuitive way. You can then select facet your queries using the attributes and filter down to the needed value.

Other things the data explorer view helps you do:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Other things the data explorer view helps you do:
Other things the data explorer view helps you:

akristen
akristen reviewed Oct 14, 2024
View reviewed changes
...ent/docs/query-your-data/explore-query-data/query-builder/introduction-new-data-explorer.mdx Outdated

Other things the data explorer view helps you do:

- View data from different perspectives: from raw data to various visualizations that provide insights on evolution, distribution, and more.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- View data from different perspectives: from raw data to various visualizations that provide insights on evolution, distribution, and more.
* View data from different perspectives: from raw data to various visualizations that provide insights on evolution, distribution, and more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We use *s to make unordered lists

akristen
akristen reviewed Oct 14, 2024
View reviewed changes
...ent/docs/query-your-data/explore-query-data/query-builder/introduction-new-data-explorer.mdx Outdated
- Add your searches to a dashboard.
- Understand how NRQL works: the Data Explorer demonstrates how queries are constructed.

### Types of Data You Can Explore
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Types of Data You Can Explore
### Understand data types [#understand-data-types]

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Keeping the same heading for simplicity.

akristen
akristen reviewed Oct 14, 2024
View reviewed changes
...ent/docs/query-your-data/explore-query-data/query-builder/introduction-new-data-explorer.mdx Outdated

In the context of Metrics and Events, "event" refers to all objects stored in the New Relic Database (NRDB). Metrics and Events allow you to explore:

- [Dimensional metrics](/docs/data-apis/understand-data/new-relic-data-types/#dimensional-metrics) (the Metric data type).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- [Dimensional metrics](/docs/data-apis/understand-data/new-relic-data-types/#dimensional-metrics) (the Metric data type).
* [Dimensional metrics](/docs/data-apis/understand-data/new-relic-data-types/#dimensional-metrics) (the Metric data type).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update list to use *s over -s

akristen
akristen reviewed Oct 14, 2024
View reviewed changes
...ent/docs/query-your-data/explore-query-data/query-builder/introduction-new-data-explorer.mdx Outdated

### Types of Data You Can Explore

In the context of Metrics and Events, "event" refers to all objects stored in the New Relic Database (NRDB). Metrics and Events allow you to explore:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
In the context of Metrics and Events, "event" refers to all objects stored in the New Relic Database (NRDB). Metrics and Events allow you to explore:
In the context of the metrics and events capability, "event" refers to all objects stored in the New Relic Database (NRDB). Metrics and Events allow you to explore:

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this doc is about query your data, we don't need to talk about metrics and events capability. This can add confusion about what capability/feature we're talking about. I recommend removing mentions of metrics and events and updating this section to talk about the query your data feature

akristen
akristen reviewed Oct 14, 2024
View reviewed changes
...ent/docs/query-your-data/explore-query-data/query-builder/introduction-new-data-explorer.mdx Outdated
- [Events](/docs/data-apis/understand-data/new-relic-data-types/#events-new-relic) (the Event data type).
- [Logs](/docs/logs/ui-data/use-logs-ui) (the Log data type).

## Exploring Your Data
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Exploring Your Data
## Exploring your data [#explore-your-data]

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Adding anchor tags to the headers. Also, we use sentence case for our headers, not snake case!

akristen
akristen reviewed Oct 14, 2024
View reviewed changes
...ent/docs/query-your-data/explore-query-data/query-builder/introduction-new-data-explorer.mdx Outdated

To access the Data Explorer, navigate to the bottom <DNT>**Query your data**</DNT> bar and click the <DNT>**Data Explorer**</DNT> icon.

### Using the Data Explorer
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add anchor tags

akristen
akristen reviewed Oct 14, 2024
View reviewed changes
...ent/docs/query-your-data/explore-query-data/query-builder/introduction-new-data-explorer.mdx Outdated
src="/images/data-explorer.gif"
/>

### Components of the Data Explorer
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add anchor tags and sentence case. 'data explorer' over 'Data Explorer'

akristen
akristen reviewed Oct 14, 2024
View reviewed changes
...ent/docs/query-your-data/explore-query-data/query-builder/introduction-new-data-explorer.mdx Outdated
3. **Build Your Search**: Use the blocks on the left to browse the available data and construct your search. Blocks are searchable, and you can use the actions in the action menu to create and modify your query.

<img
title="Metrics and events view"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lets update this title to reflect data explorer, not metrics and events

@github-actions GitHub Actions
Copy link

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).

@github-actions GitHub Actions
Copy link

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).

1 similar comment
@github-actions GitHub Actions
Copy link

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).

@github-actions GitHub Actions
Copy link

[!NOTE]

Our Vale automated writing feedback tool has suggestions for this PR. You can view these suggestions in the Files changed tab. If you're not a New Relic docs writer, we'll review any comments and you don't need to take any action (though feel free to make edits if you like!).

akristen
akristen reviewed Oct 16, 2024
View reviewed changes
...ent/docs/query-your-data/explore-query-data/query-builder/introduction-new-data-explorer.mdx Outdated
Need to perform a more detailed search? Read how to [query your data](/docs/query-your-data/explore-query-data/get-started/introduction-querying-new-relic-data/). If you haven't already, create your free New Relic account to start monitoring your data today.


## Why it matters [#why-it-matters]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's update this h2 to be more specific.

akristen
akristen reviewed Oct 16, 2024
View reviewed changes
...ent/docs/query-your-data/explore-query-data/query-builder/introduction-new-data-explorer.mdx Outdated
* [Events](/docs/data-apis/understand-data/new-relic-data-types/#events-new-relic) (the Event data type).
* [Logs](/docs/logs/ui-data/use-logs-ui) (the Log data type).

## Exploring your data [#exploring-your-data]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't use -ing formations for h2s. Please change to active voice, eg "Explore your data"

akristen
akristen reviewed Oct 16, 2024
View reviewed changes
...ent/docs/query-your-data/explore-query-data/query-builder/introduction-new-data-explorer.mdx Outdated

To access the Data Explorer, navigate to the bottom <DNT>**Query your data**</DNT> bar and click the <DNT>**Data Explorer**</DNT> icon.

### Using the Data Explorer [#using-data-explorer]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using -> Use

akristen
akristen reviewed Oct 16, 2024
View reviewed changes
...ent/docs/query-your-data/explore-query-data/query-builder/introduction-new-data-explorer.mdx Outdated
src="/images/data-explorer.gif"
/>

### Components of the Data Explorer [#data-explorer-components]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't capitalilze capabiblities. Data Explorer -> data explorer

akristen
akristen requested changes Oct 16, 2024
View reviewed changes
Copy link
Contributor

@akristen akristen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor style guide updates and then I'll approve!

@cbehera-newrelic cbehera-newrelic merged commit d59a50b into develop Oct 16, 2024
18 checks passed
@cbehera-newrelic cbehera-newrelic deleted the NR-316996-data-explorer-integration branch October 16, 2024 16:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@akristen akristen akristen approved these changes

Assignees

@cbehera-newrelic cbehera-newrelic

Labels
content requests related to docs site content from_tw Identifies issues/PRs from Tech Docs writers
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@cbehera-newrelic @akristen