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

chore: add language identifiers and fix some syntax #15514

Merged
merged 3 commits into from
Dec 14, 2023
Merged
Show file tree
Hide file tree
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
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ The Prometheus exporter application, `nri-aerospike`, is available on the apt-ge

1. To install nri-aerospike, use the command below:

```
```bash
sudo apt-get install nri-aerospike
```
You'll know nri-aerospike was successfully installed because:
Expand All @@ -47,25 +47,25 @@ You'll know nri-aerospike was successfully installed because:

Your configuration file should look like this

```
```yml
integrations:
- name: nri-aerospike
config:
# API URL of the aerospike service
aerospike_db_host: localhost
aerospike_db_port: 3000
- name: nri-aerospike
config:
# API URL of the aerospike service
aerospike_db_host: localhost
aerospike_db_port: 3000

# Port to expose scrape endpoint on, If this is not provided a random port will be used to launch the exporter
exporter_port: 9145
# Port to expose scrape endpoint on, If this is not provided a random port will be used to launch the exporter
exporter_port: 9145

# Cluster name is used on the aerospike.prometheus.json.template - all the metrics captured by nri-prometheus will be categorised under this cluster name
aerospike_cluster_name: YOUR_DESIRED_CLUSTER_NAME
scrape_timeout: 5s
# Cluster name is used on the aerospike.prometheus.json.template - all the metrics captured by nri-prometheus will be categorized under this cluster name
aerospike_cluster_name: YOUR_DESIRED_CLUSTER_NAME
scrape_timeout: 5s

label_type: development
label_source: aerospike
label_type: development
label_source: aerospike

exporter_files_path: /tmp
exporter_files_path: /tmp
```

After you've successfully configured `nri-aerospike` you will be able to see the list of monitored Aerospike metrics in `http://localhost:9145/metrics`.
Expand All @@ -87,7 +87,7 @@ This integration reports data in the form of our [infrastructure agent](/docs/in

Here's an example NRQL query checking the percentage of memory capacity free on the namespace:

```
```sql
FROM Metric
SELECT latest (aerospike_namespace_memory_free_pct)
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ Tips on configuration:

In the integrations directory, `C:\Program Files\New Relic\newrelic-infra\integrations.d\`, create a copy of the sample configuration file by running:

```
```shell
cp apache-config.yml.sample apache-config.yml
```

Expand All @@ -135,7 +135,7 @@ To enable automatic Apache and Apache error log parsing and forwarding, copy or
>
In the integrations directory, `/etc/newrelic-infra/integrations.d/`, create a copy of the sample configuration file by running:

```
```shell
sudo cp apache-config.yml.sample apache-config.yml
```

Expand Down Expand Up @@ -187,15 +187,15 @@ The Apache integration collects both metrics and inventory information. This tab
<tbody>
<tr>
<td>
**STATUS_URL**
`STATUS_URL`
</td>

<td>
The URL set up to provide the metrics using the status module.
</td>

<td>
[http://127.0.0.1/server-status?auto](http://127.0.0.1/server-status?auto)
`http://127.0.0.1/server-status?auto`
</td>

<td style={{ "text-align": "center" }}>
Expand All @@ -209,7 +209,7 @@ The Apache integration collects both metrics and inventory information. This tab

<tr>
<td>
**BINARY_PATH**
`BINARY_PATH`
</td>

<td>
Expand All @@ -231,7 +231,7 @@ The Apache integration collects both metrics and inventory information. This tab

<tr>
<td>
**CA_BUNDLE_FILE**
`CA_BUNDLE_FILE`
</td>

<td>
Expand All @@ -253,7 +253,7 @@ The Apache integration collects both metrics and inventory information. This tab

<tr>
<td>
**CA_BUNDLE_DIR**
`CA_BUNDLE_DIR`
</td>

<td>
Expand All @@ -275,7 +275,7 @@ The Apache integration collects both metrics and inventory information. This tab

<tr>
<td>
**VALIDATE_CERTS**
`VALIDATE_CERTS`
</td>

<td>
Expand All @@ -297,7 +297,7 @@ The Apache integration collects both metrics and inventory information. This tab

<tr>
<td>
**[REMOTE_MONITORING](https://docs.newrelic.com/docs/remote-monitoring-host-integrations)**
[`REMOTE_MONITORING`](https://docs.newrelic.com/docs/remote-monitoring-host-integrations)
</td>

<td>
Expand All @@ -319,7 +319,7 @@ The Apache integration collects both metrics and inventory information. This tab

<tr>
<td>
**METRICS**
`METRICS`
</td>

<td>
Expand All @@ -339,7 +339,7 @@ The Apache integration collects both metrics and inventory information. This tab

<tr>
<td>
**INVENTORY**
`INVENTORY`
</td>

<td>
Expand Down Expand Up @@ -367,10 +367,10 @@ You can further decorate your metrics using labels. Labels allow you to add attr

Our default sample config file includes examples of labels but, because they're not mandatory, you can remove, modify, or add new ones of your choice.

```
labels:
env: production
role: load_balancer
```yml
labels:
env: production
role: load_balancer
```

## Example configurations [#examples]
Expand All @@ -384,7 +384,7 @@ Here are some example YAML configurations:
>
This is a very basic configuration to collect metrics and inventory from your localhost:

```
```yml
integrations:
- name: nri-apache
env:
Expand Down Expand Up @@ -413,9 +413,9 @@ Here are some example YAML configurations:
id="example2"
title="HTTP basic authentication"
>
This configuration collects metrics and inventory from your localhost protected with basic authentication. Replace the `username` and `password` on the STATUS_URL with your credentials:
This configuration collects metrics and inventory from your localhost protected with basic authentication. Replace the `username` and `password` on the `STATUS_URL` with your credentials:

```
```yml
integrations:
- name: nri-apache
env:
Expand Down Expand Up @@ -446,7 +446,7 @@ Here are some example YAML configurations:
>
By default the integration tries to detect the Apache binary on these 2 different locations: `/usr/sbin/httpd` and `/usr/sbin/apache2ctl`.<br/>If your Apache is installed on a custom location or you are using MS Windows, use the `BINARY_PATH` setting to specify the correct location and filename of your Apache binary:

```
```yml
integrations:
- name: nri-apache
env:
Expand Down Expand Up @@ -478,7 +478,7 @@ Here are some example YAML configurations:
>
In this configuration we only have one integration block with `METRICS: true` to collect only metrics and added `VALIDATE_CERTS: false` to prevent validation of the server's SSL certificate when using a self-signed one:

```
```yml
integrations:
- name: nri-apache
env:
Expand All @@ -499,13 +499,13 @@ Here are some example YAML configurations:
>
In this configuration we only have one integration block with `METRICS: true` to collect only metrics and added `CA_BUNDLE_FILE` pointing to an alternative certificate file:

```
```yml
integrations:
- name: nri-apache
env:
METRICS: "true"
STATUS_URL: https://my_apache_host/server-status?auto
CA_BUNDLE_FILE='/etc/ssl/certs/custom-ca.crt'
CA_BUNDLE_FILE: '/etc/ssl/certs/custom-ca.crt'
REMOTE_MONITORING: true
interval: 15s
labels:
Expand All @@ -520,12 +520,12 @@ Here are some example YAML configurations:
>
In this configuration we are using the environment variable `APACHE_STATUS` to populate the STATUS_URL setting of the integration:

```
```yml
integrations:
- name: nri-apache
env:
METRICS: "true"
STATUS_URL: {{APACHE_STATUS}}
STATUS_URL: { { APACHE_STATUS } }
REMOTE_MONITORING: true
interval: 15s
labels:
Expand All @@ -540,7 +540,7 @@ Here are some example YAML configurations:
>
In this configuration we are monitoring multiple Apache servers from the same integration. For the first instance (`STATUS_URL: https://1st_apache_host/server-status?auto`) we are collecting metrics and inventory while for the second instance (`STATUS_URL: https://2nd_apache_host/server-status?auto`) we will only collect metrics.

```
```yml
integrations:
- name: nri-apache
env:
Expand Down Expand Up @@ -788,18 +788,18 @@ Besides the standard attributes collected by the infrastructure agent, the integ

* Although you cannot ignore the SSL certification, you can set the config file parameters `ca_bundle_file` and `ca_bundle_dir` to point to an unsigned certificate in the Apache config file. Example:

```
```yml
instances:
- name: apache-server-metrics
- name: apache-server-metrics
command: metrics
arguments:
status_url: http://127.0.0.1/server-status?auto
ca_bundle_file: /etc/newrelic-infra/integrations.d/ssl/b2b.ca-bundle
status_url: http://127.0.0.1/server-status?auto
ca_bundle_file: /etc/newrelic-infra/integrations.d/ssl/b2b.ca-bundle
```

An example using `ca_bundle_dir`:

```
```yml
ca_bundle_dir: /etc/newrelic-infra/integrations.d/ssl
```
* Alternatively, you can use HTTP instead of HTTPS.
Expand Down
Loading