Skip to content

Commit 1bf6055

Browse files
authored
Merge pull request newrelic#13845 from brnhensley/patch-10
chore: add language identifiers/fix typos
2 parents 296e601 + f4a6745 commit 1bf6055

File tree

8 files changed

+67
-65
lines changed

8 files changed

+67
-65
lines changed

src/content/docs/data-apis/ingest-apis/event-api/incident-event-rest-api.mdx

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -56,12 +56,12 @@ The `eventType` field must use `NrAiIncidentExternal`.
5656

5757
Here's an example of how to use curl to send your JSON payload.
5858

59-
```
59+
```bash
6060
gzip -c example_incidents.json | curl --data-binary @- -X POST -H "Content-Type: application/json" -H "Api-Key: YOUR_LICENSE_KEY" -H "Content-Encoding: gzip"
6161
https://insights-collector.newrelic.com/v1/accounts/YOUR_ACCOUNT/events
6262
```
6363

64-
```
64+
```json
6565
Response
6666
{"success":true, "uuid":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}%
6767
```
@@ -74,7 +74,7 @@ You can query your data with [Nerdgraph API](/docs/apis/nerdgraph/get-started/in
7474

7575
Here's an example of a NerdGraph query and its result.
7676

77-
```json
77+
```graphql
7878
{
7979
actor {
8080
account(id: YOUR_ACCOUNT_ID) {
@@ -175,7 +175,7 @@ The incident event API uses the Event API's value types. For descriptions of the
175175
<td>
176176
`state`
177177

178-
_enum: (trigger, resolve)_
178+
_enum: (`trigger`, `resolve`)_
179179
</td>
180180

181181
<td>
@@ -189,11 +189,11 @@ The incident event API uses the Event API's value types. For descriptions of the
189189
<td>
190190
`priority`
191191

192-
_enum: (low, medium, high, critical)_
192+
_enum: (`low`, `medium`, `high`, `critical`)_
193193
</td>
194194

195195
<td>
196-
The incident's priority. Default: _high_.
196+
The incident's priority. Default: `high`.
197197

198198
Highest priority will be used when different priorities are sent.
199199
</td>
@@ -207,7 +207,7 @@ The incident event API uses the Event API's value types. For descriptions of the
207207
</td>
208208

209209
<td>
210-
**REQUIRED, when `state` is _trigger_**
210+
**REQUIRED, when `state` is `trigger`**
211211

212212
The triggering event's title.
213213
</td>
@@ -221,7 +221,7 @@ The incident event API uses the Event API's value types. For descriptions of the
221221
</td>
222222

223223
<td>
224-
**REQUIRED, when `state` is _trigger_**
224+
**REQUIRED, when `state` is `trigger`**
225225

226226
The origin of the incident, or the monitoring system that triggered it (not the entity that faulted).
227227
</td>

src/content/docs/data-apis/ingest-apis/event-api/introduction-event-api.mdx

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -232,19 +232,19 @@ The Event API accepts specific formats for attributes included in the payload. O
232232
>
233233
Here is an example of a typical JSON data set for sending with the API. This call sends two **Purchase** type events as a JSON array. You can add multiple events in a single HTTP call using a JSON array.
234234

235-
```
235+
```json
236236
[
237-
{
238-
"eventType":"Purchase",
239-
"account":3,
240-
"amount":259.54
241-
},
242-
{
243-
"eventType":"Purchase",
244-
"account":5,
245-
"amount":12309,
246-
"product":"Item"
247-
}
237+
{
238+
"eventType": "Purchase",
239+
"account": 3,
240+
"amount": 259.54
241+
},
242+
{
243+
"eventType": "Purchase",
244+
"account": 5,
245+
"amount": 12309,
246+
"product": "Item"
247+
}
248248
]
249249
```
250250

@@ -283,7 +283,7 @@ Data submitted to the Event API uses a compressed JSON format in a simple HTTPS
283283
id="numberone"
284284
title="Linux/bash example"
285285
>
286-
```
286+
```bash
287287
gzip -c example_events.json | curl -X POST -H "Content-Type: application/json"
288288
-H "Api-Key: YOUR_LICENSE_KEY" -H "Content-Encoding: gzip"
289289
https://insights-collector.newrelic.com/v1/accounts/YOUR_ACCOUNT_ID/events --data-binary @-
@@ -294,7 +294,7 @@ Data submitted to the Event API uses a compressed JSON format in a simple HTTPS
294294
id="numbertwo"
295295
title="Windows/PowerShell example"
296296
>
297-
```
297+
```powershell
298298
$accountId = "YOUR_ACCOUNT_ID"
299299
$insertkey = "YOUR_LICENSE_KEY"
300300
# Replace with your custom event for the body
@@ -373,7 +373,7 @@ Other potential issues:
373373
</td>
374374

375375
<td>
376-
```
376+
```json
377377
{"success":true,"uuid":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"}
378378
```
379379
</td>
@@ -592,7 +592,7 @@ Other potential issues:
592592

593593
The [`NrIntegrationError` event](/docs/telemetry-data-platform/manage-data/nrintegrationerror) allows you to query and set alerts on custom data being sent to your New Relic account. **Recommendation:** To get alerts for parsing errors, [create a NRQL alert condition](/docs/alerts/new-relic-alerts/defining-conditions/create-alert-conditions-nrql-queries) for `NrIntegrationError`. Use this example NRQL query:
594594

595-
```
595+
```sql
596596
SELECT message FROM NrIntegrationError WHERE newRelicFeature = 'Event API' AND category = 'EventApiException'
597597
```
598598

@@ -654,7 +654,7 @@ SELECT message FROM NrIntegrationError WHERE newRelicFeature = 'Event API' AND c
654654

655655
<tr>
656656
<td>
657-
`Category`
657+
`category`
658658
</td>
659659

660660
<td>
@@ -664,7 +664,7 @@ SELECT message FROM NrIntegrationError WHERE newRelicFeature = 'Event API' AND c
664664

665665
<tr>
666666
<td>
667-
`Message`
667+
`message`
668668
</td>
669669

670670
<td>
@@ -674,7 +674,7 @@ SELECT message FROM NrIntegrationError WHERE newRelicFeature = 'Event API' AND c
674674

675675
<tr>
676676
<td>
677-
`Name`
677+
`name`
678678
</td>
679679

680680
<td>
@@ -698,7 +698,7 @@ SELECT message FROM NrIntegrationError WHERE newRelicFeature = 'Event API' AND c
698698

699699
To find data sent via the Event API (and from integrations that use this API), you can query it. For example, to query a custom event using [NRQL](/docs/query-data/nrql-new-relic-query-language/getting-started/introduction-nrql), you would run:
700700

701-
```
701+
```sql
702702
SELECT * FROM YOUR_CUSTOM_EVENT
703703
```
704704

src/content/docs/data-apis/ingest-apis/gateway-api-import-data-other-observability-platforms.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Here's an overview of the steps for enabling the Gateway API for DataDog:
2828
1. For DataDog: Our account representatives will work with you to map your Datadog API keys to New Relic keys.
2929
2. For each agent configuration file, point the data to `https://gateway.service.newrelic.com`. An example for DataDog: in the agent’s `datadog.yaml` file, you’d change these settings:
3030

31-
```
31+
```yml
3232
dd_url: https://gateway.service.newrelic.com
3333
logs_config:
3434
logs_dd_url: https://gateway.service.newrelic.com
@@ -48,4 +48,4 @@ Telemetry data brought in from third-party platforms doesn't map perfectly to ou
4848
4949
<Callout variant="tip">
5050
Interested in unifying your data observability into a single platform? See our [guide on migrating from Datadog](/docs/journey-migration/migrating-from-dd/) to try it out for free.
51-
</Callout>
51+
</Callout>

src/content/docs/logs/log-api/use-tcp-endpoint-forward-logs-new-relic.mdx

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ To forward logs to New Relic with `rsyslog` for Amazon Linux, Redhat, and Centos
4242
3. In the `/etc/rsyslog.d/` directory, create a text file named `newrelic.conf`.
4343
4. Check whether the `$IncludeConfig` options under `/etc/rsyslog.conf` already have a matching wildcard that will include the newly created `newrelic.conf` file under the `/etc/rsyslog.d` directory. Otherwise you'll need to explicitly include `/etc/rsyslog.d/newrelic.conf` in `/etc/rsyslog.conf` using `$IncludeConfig /etc/rsyslog.d/newrelic.conf`
4444

45-
5. Add the following to `newrelic.conf`. Replace the highlighted values. For YOUR_LICENSE_KEY, use your New Relic <InlinePopover type="licenseKey" />:
45+
5. Add the following to `newrelic.conf`. Replace the highlighted values. For `YOUR_LICENSE_KEY`, use your New Relic <InlinePopover type="licenseKey" />:
4646

4747
```properties
4848
## Specify each of the files to be tailed in case step 1 is done
@@ -120,7 +120,7 @@ To configure `rsyslog` versions 8 and above for Amazon Linux, Redhat, and Centos
120120
Note the configured port number is `6516` instead of `6514`.
121121
</Callout>
122122

123-
2. Add the following to `newrelic.conf`. Replace all highlighted values. For YOUR_LICENSE_KEY, use your New Relic <InlinePopover type="licenseKey" />:
123+
2. Add the following to `newrelic.conf`. Replace all highlighted values. For `YOUR_LICENSE_KEY`, use your New Relic <InlinePopover type="licenseKey" />:
124124

125125
```properties
126126
## Specify each of the files to be tailed in case step 1 is done
@@ -155,8 +155,7 @@ To configure `rsyslog` versions 8 and above for Amazon Linux, Redhat, and Centos
155155
```
156156
3. Restart the `rsyslog` service by running:
157157

158-
```
159-
bash
158+
```bash
160159
sudo systemctl restart rsyslog
161160
```
162161
4. [Check your New Relic account](/docs/logs/log-management/ui-data/explore-your-data-log-analytics) for logs.
@@ -167,8 +166,7 @@ If you're using rsyslog version 7 or below, the configuration files need to be a
167166

168167
1. Install packages required to allow `rsyslog` to send logs using TLS encryption:
169168

170-
```
171-
bash
169+
```bash
172170
sudo yum install rsyslog-gnutls ca-certificates
173171
```
174172
2. Optional: Configure `rsyslog` to tail log files and forward their contents to New Relic. Add the following to the `/etc/rsyslog.conf` file in order to enable its text file input module:
@@ -181,7 +179,7 @@ If you're using rsyslog version 7 or below, the configuration files need to be a
181179
```
182180
3. In the `/etc/rsyslog.d/` directory, create a text file named `newrelic.conf`.
183181
4. Check whether the `$IncludeConfig` options under `/etc/rsyslog.conf` already have a matching wildcard that will include the newly created `newrelic.conf` file under the `/etc/rsyslog.d` directory. Otherwise you'll need to explicitly include `/etc/rsyslog.d/newrelic.conf` in `/etc/rsyslog.conf` using `$IncludeConfig /etc/rsyslog.d/newrelic.conf`.
184-
5. Add the following to `newrelic.conf`. Replace the highlighted values. For YOUR_LICENSE_KEY, use your New Relic <InlinePopover type="licenseKey" />:
182+
5. Add the following to `newrelic.conf`. Replace the highlighted values. For `YOUR_LICENSE_KEY`, use your New Relic <InlinePopover type="licenseKey" />:
185183

186184
```properties
187185
## Template expected by the New Relic Syslog endpoint
@@ -218,8 +216,7 @@ To forward logs to New Relic with `syslog-ng`:
218216

219217
1. Install `ca-certificates` required to allow `syslog-ng` to send logs using TLS encryption:
220218

221-
```
222-
bash
219+
```bash
223220
sudo yum install ca-certificates
224221
```
225222
2. Open the `syslog-ng` configuration file (`/etc/syslog-ng/syslog-ng.conf`) in a text editor.
@@ -237,7 +234,7 @@ To forward logs to New Relic with `syslog-ng`:
237234
file("PATH_TO_FILE");
238235
};
239236
```
240-
5. Define the New Relic `syslog` format. For YOUR_LICENSE_KEY, use your New Relic <InlinePopover type="licenseKey" />.
237+
5. Define the New Relic `syslog` format. For `YOUR_LICENSE_KEY`, use your New Relic <InlinePopover type="licenseKey" />.
241238

242239
```properties
243240
template NRFormat { template("YOUR_LICENSE_KEY <${PRI}>1 ${ISODATE} ${HOST:--} ${PROGRAM:--} ${PID:--} ${MSGID:--} ${SDATA:--} $MSG\n");
@@ -273,4 +270,4 @@ To forward logs to New Relic with `syslog-ng`:
273270

274271
<Callout variant="tip">
275272
If you're running syslog-ng from a Docker container and experience issues, check [balait/syslog image documentation](https://hub.docker.com/r/balabit/syslog-ng/).
276-
</Callout>
273+
</Callout>

src/content/docs/logs/troubleshooting/log-message-truncated.mdx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,14 +66,15 @@ If you have values exceeding the character limit, here are some options to try:
6666

6767
To query for logs that have likely exceeded this storage limit in New Relic, run the following query:
6868

69-
```
69+
```sql
7070
SELECT * FROM Log WHERE length(message) >= 4094
7171
```
7272

7373
To expand the blob data, run the following query, using `message` or any other attribute. Be sure to enclose the blob's attribute with backticks. For example:
7474

75-
```
76-
SELECT message, another-attribute, blob(`newrelic.ext.message`), blob(`newrelic.ext.another-attribute`) FROM Log
75+
```sql
76+
SELECT message, another-attribute, blob(`newrelic.ext.message`), blob(`newrelic.ext.another-attribute`)
77+
FROM Log
7778
```
7879

7980
For more information, see our documentation about [long messages stored as blobs](https://docs.newrelic.com/docs/logs/log-management/ui-data/long-logs-blobs/).

src/content/docs/logs/troubleshooting/no-log-data-appears-ui.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ For the infrastructure agent: see [logging config options](/docs/infrastructure/
137137
<td>
138138
Try querying the `Log` data type:
139139

140-
```
140+
```sql
141141
SELECT * FROM Log
142142
```
143143

src/content/docs/vulnerability-management/integrations/aws.mdx

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -54,15 +54,19 @@ Once you've created an API destination for ingest, create an Eventbridge rule to
5454
2. Option: choose any Security Hub sample event from the dropdown to test your rule against.
5555
3. For the event pattern, enter the select the custom patterns pane and input a pattern. For example the pattern below matches events from Security Hub, Guard Duty, and Inspector:
5656

57-
```
57+
```json
5858
{
59-
"detail-type": [{
60-
"prefix": "Security Hub"
61-
}, {
62-
"prefix": "GuardDuty Finding"
63-
}, {
64-
"prefix": "Inspector2"
65-
}]
59+
"detail-type": [
60+
{
61+
"prefix": "Security Hub"
62+
},
63+
{
64+
"prefix": "GuardDuty Finding"
65+
},
66+
{
67+
"prefix": "Inspector2"
68+
}
69+
]
6670
}
6771
```
6872

@@ -79,7 +83,7 @@ Configure your tags as needed.
7983

8084
### E. Review and Create
8185

82-
Review all your selections and make any changes as necessary.
86+
Review all your selections and make any changes as necessary.
8387

8488
### F. Review in NRDB
8589

@@ -89,4 +93,4 @@ To review logs ingested via AWS Event Bridge, you can use the following NRQL que
8993
FROM Vulnerability SELECT * WHERE source LIKE 'AWS%' SINCE 3 MONTHS AGO
9094
```
9195

92-
Note that GuardDuty and Inspector results will only show this way, while SecurityHub vulnerabilities will be visible in New Relic's Vulnerability Management (if available)
96+
Note that GuardDuty and Inspector results will only show this way, while SecurityHub vulnerabilities will be visible in New Relic's Vulnerability Management (if available).

src/content/docs/vulnerability-management/integrations/trivy.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@ To ingest your Trivy scan result files in SARIF into New Relic, utilize the secu
1616

1717
Here's an example curl POST:
1818

19-
```
19+
```bash
2020
curl --location --request POST 'https://security-api.newrelic.com/security/v1?repository=<https://github.com/MY_GITHUB_USER/MY_TRIVY_REPO>' \
21-
--header 'Api-Key: <NewRelicLicenseKey>' \
22-
--header 'Content-Type: application/json' \
23-
--header 'X-Scanner: Trivy' \
24-
-d @nameOfSarifFile.json
21+
--header 'Api-Key: YOUR_LICENSE_KEY' \
22+
--header 'Content-Type: application/json' \
23+
--header 'X-Scanner: Trivy' \
24+
-d @nameOfSarifFile.json
2525
```
2626

2727
<Callout variant='tip'>
@@ -31,17 +31,17 @@ curl --location --request POST 'https://security-api.newrelic.com/security/v1?re
3131
## Confirm scan import activity
3232
The HTTP response from the POST will include a request uuid and information about the request. For example:
3333

34-
```
34+
```json
3535
{
36-
"success":false,
37-
"errorMessage":null,
38-
"uuid":"4740e3c8-dbc4-46e6-a4b2-a7fb6f918d20"
36+
"success": false,
37+
"errorMessage": null,
38+
"uuid": "4740e3c8-dbc4-46e6-a4b2-a7fb6f918d20"
3939
}
4040
```
4141

4242
The request guid is included in all vulnerability events which can be [queried with NRQL](/docs/query-your-data/nrql-new-relic-query-language/get-started/introduction-nrql-new-relics-query-language/). These events are written in real time as the import job runs. To view the status and output of an import as it runs, use this NRQL query (replacing `YOUR_REQUEST_ID` with the uuid returned from your HTTP POST):
4343

44-
```
44+
```sql
4545
FROM Log SELECT * WHERE source = 'Trivy' AND requestId = 'YOUR_REQUEST_ID'
4646
```
4747
To see scan results visit [Vulnerability Management](https://docs.newrelic.com/docs/vulnerability-management/overview/).

0 commit comments

Comments
 (0)