This repository has been archived by the owner on Dec 15, 2021. It is now read-only.
Docs team edits #30
Open
Docs team edits #30
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
|
|
MrAlias
reviewed
Mar 19, 2020
| * A Healthy Istio deployment | ||
| * A New Relic Insights Insert API Key. | ||
| * A healthy Istio deployment | ||
| * A [New Relic Insights Insert API Key](https://docs.newrelic.com/docs/apis/get-started/intro-apis/types-new-relic-api-keys#event-insert-key). |
| @@ -118,8 +118,7 @@ newrelic-response-size 10s | |||
| newrelic-span 10s | |||
| ``` | |||
|
|
|||
| You should start to see metrics sent to [Insights](https://insights.newrelic.com) a few minutes after the deployment. | |||
| As an example, this Insights query will display a timeseries graph of total Istio requests: | |||
| You should be able to query your data via [NRQL](https://docs.newrelic.com/docs/query-data/nrql-new-relic-query-language/getting-started/introduction-nrql) within a few minutes of deployment. For example, this NRQL query will display a timeseries graph of total Istio requests: | |||
There was a problem hiding this comment.
I'm a fan of wrapping on sentence breaks to make reviews of the Markdown changes easier to understand.
Suggested change
| You should be able to query your data via [NRQL](https://docs.newrelic.com/docs/query-data/nrql-new-relic-query-language/getting-started/introduction-nrql) within a few minutes of deployment. For example, this NRQL query will display a timeseries graph of total Istio requests: | |
| You should be able to query your data via [NRQL](https://docs.newrelic.com/docs/query-data/nrql-new-relic-query-language/getting-started/introduction-nrql) within a few minutes of deployment. | |
| For example, this NRQL query will display a timeseries graph of total Istio requests: |
|
|
||
| - Metric data: see [Metric API docs](https://docs.newrelic.com/docs/data-ingest-apis/get-data-new-relic/metric-api/introduction-metric-api#find-data). | ||
| - Trace/span data: see [Trace API docs](https://docs.newrelic.com/docs/understand-dependencies/distributed-tracing/trace-api/introduction-trace-api#view-data). | ||
| Tips on how to find and query your data in New Relic: |
There was a problem hiding this comment.
Suggested change
| Tips on how to find and query your data in New Relic: | |
| Tips on how to find and query your data in New Relic: | |
| @@ -1,26 +1,26 @@ | |||
| [](https://goreportcard.com/report/github.com/newrelic/newrelic-istio-adapter) | |||
| [](https://travis-ci.com/newrelic/newrelic-istio-adapter) | |||
|
|
|||
| # New Relic Istio Adapter | |||
| # New Relic Istio adapter | |||
There was a problem hiding this comment.
I prefer using title case for section headers. Is this case structure a standard we are trying to adhere to?
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is from Zach Elwood on NR docs team.
This PR is to add a ‘how to find data’ section so that customers can find the data they send. I’ve included what I think are the applicable data types (spans and metrics) but let me know if there are other data types reported by this exporter. If you think this exporter will change to send other types of data in future, keep in mind it will be important to update this repo with link to that data type.
Also changed some instances of title case to sentence case; small thing but we want headings to be sentence case and not title case, so just something to keep in mind when creating new content. Let me know if you think I changed sentence case stuff that shouldn't have been changed.
Also changed from 'Use Insights' to 'Use NRQL'. We want to avoid instances of Insights because we want to promote NR1 chart builder, or just mention NRQL for specific NRQL use cases.