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

changes #70

Merged
merged 2 commits into from
Aug 1, 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
4 changes: 2 additions & 2 deletions docs/_include/general-shipping/replace-placeholders.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Replace the placeholders to match your specifics. (They are indicated by the double angle brackets `<< >>`):

* {@include: ../../_include/log-shipping/log-shipping-token.html}
* {@include: ../_include/log-shipping/log-shipping-token.html}

* {@include: ../../_include/log-shipping/listener-var.html}
* {@include: ../_include/log-shipping/listener-var.html}


6 changes: 3 additions & 3 deletions docs/shipping/aiven.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: Aiven
title: Aiven
overview: 'Aiven is a cloud service provider that specializes in managed open-source database, messaging, and event streaming solutions'
overview: Aiven is a cloud service provider that specializes in managed open-source database, messaging, and event streaming solutions.
product: ['logs']
os: []
filters: ['Other']
Expand All @@ -21,7 +21,7 @@ metrics_alerts: []
* an Aiven project with the service enabled


##### Configure Aiven to send syslog notifications to Logz.io
## Configure Aiven to send syslog notifications to Logz.io

1. Log in to your Aiven account and navigate to **Projects**.
2. Select the project that you need to send logs from.
Expand Down Expand Up @@ -85,7 +85,7 @@ metrics_alerts: []
![7](https://dytvr9ot2sszz.cloudfront.net/logz-docs/aiven/aiven7.png)


##### Check Logz.io for your logs
### Check Logz.io for your logs

Give your logs some time to get from your system to ours, and then open [Open Search Dashboards](https://app.logz.io/#/dashboard/osd). You can filter for data of type `Aiven` to see the incoming Aiven logs.

Expand Down
22 changes: 11 additions & 11 deletions docs/shipping/alcide-kaudit.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Alcide kAudit is a security service for monitoring Kubernetes audit logs, and ea

You can review Alcide kAudit findings in your Logz.io security account, including a pre-configured [Alcide dashboard in Logz.io](https://app.logz.io/#/dashboard/security/research/dashboards?) to get you started.

#### Configuration
## Configure Alcide kAudit

You can configure an Alcide kAudit integration that uses the Logz.io HTTPS API. The integration can be configured from the kAudit app or kAudit Kubernetes ConfigMap.

Expand All @@ -31,7 +31,7 @@ For more information on exporting kAudit findings, see the official [Alcide docs
* A shipping token and listener host information for your [Logz.io Operations account](https://app.logz.io/)


##### Configure an Alcide kAudit integration for detections
### Configure an Alcide kAudit integration for detections

First, log into your Alcide kAudit console.

Expand All @@ -46,32 +46,32 @@ First, log into your Alcide kAudit console.
https://<<LISTENER-HOST>>:8071
```

3. **Token** - Paste in the log shipping token of the account you want to ship to.
3. **Token** - Paste in the log shipping token of the account you want to ship to.

4. **Alert type** - Select **Detections** from the dropdown list.
4. **Alert type** - Select **Detections** from the dropdown list.

Select all available sub-selections:
Select all available sub-selections:

* **Entity Type** - select all types: **Cluster**, **User**, **Resource**
* **Category** - select all categories: **Incident** and **Anomaly**
* **Entity Type** - select all types: **Cluster**, **User**, **Resource**
* **Category** - select all categories: **Incident** and **Anomaly**

![Set up an Alcide kAudit integration with Logz.io](https://dytvr9ot2sszz.cloudfront.net/logz-docs/security-integrations/alcide-integration.png)

##### Configure an Alcide kAudit integration for audit violations
### Configure an Alcide kAudit integration for audit violations

Repeat the above steps, only this time select **Alert type** - **Audit Violations**.

In the field **Report**, select the **Details** option.
Leave all other default configurations.

##### Configure an Alcide kAudit integration for audit activity
### Configure an Alcide kAudit integration for audit activity

Repeat the above steps, only this time select **Alert type** - **Audit Activity**.

Leave the default configurations. No sub-selections are required.

##### Check Logz.io for your logs
### Check Logz.io for your logs

Give your logs some time to get from your system to ours, and then open [Open Search Dashboards](https://app.logz.io/#/dashboard/osd). You can search or filter for Alcide logs, under `type:alcide-kaudit`.

If you still don't see your logs, see log shipping troubleshooting.
If you still don't see your logs, see [log shipping troubleshooting](/user-guide/log-shipping/log-shipping-troubleshooting.html).
17 changes: 8 additions & 9 deletions docs/shipping/apache-activemq.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: Apache-ActiveMQ
title: Apache ActiveMQ
overview: This integration creates a Kinesis Data Firehose delivery stream that links to your Amazon S3 metrics stream and then sends the metrics to your Logz.io account. It also creates a Lambda function that adds AWS namespaces to the metric stream, and a Lambda function that collects and ships the resources' tags.
overview: Apache ActiveMQ is an open source message broker with a Java Message Service client. Telegraf is a plug-in driven server agent for collecting and sending metrics and events from various sources.
product: ['metrics']
os: ['windows', 'linux']
filters: ['Distributed Messaging']
Expand All @@ -14,21 +14,20 @@ metrics_alerts: []
---


## Overview

Apache ActiveMQ is an open source message broker written in Java together with a full Java Message Service client. Telegraf is a plug-in driven server agent for collecting and sending metrics and events from databases, systems and IoT sensors.

To send your Prometheus-format ActiveMQ metrics to Logz.io, you need to add the **inputs.activemq** and **outputs.http** plug-ins to your Telegraf configuration file.

#### Configuring Telegraf to send your metrics data to Logz.io
## Configuring Telegraf to send your metrics data to Logz.io



##### Set up Telegraf v1.17 or higher
### Set up Telegraf v1.17 or higher

{@include: ../_include/metric-shipping/telegraf-setup.md}

##### Add the inputs.activemq plug-in
### Add the inputs.activemq plug-in

First you need to configure the input plug-in to enable Telegraf to scrape the ActiveMQ data from your hosts. To do this, add the following code to the configuration file:

Expand Down Expand Up @@ -61,20 +60,20 @@ First you need to configure the input plug-in to enable Telegraf to scrape the A
```

:::note
The full list of data scraping and configuring options can be found [here](https://github.com/influxdata/telegraf/blob/release-1.18/plugins/inputs/activemq/README.md)
The full list of data scraping and configuring options can be found [here](https://github.com/influxdata/telegraf/blob/release-1.18/plugins/inputs/activemq/README.md).
:::


##### Add the outputs.http plug-in
### Add the outputs.http plug-in

{@include: ../_include/metric-shipping/telegraf-outputs.md}
{@include: ../_include/general-shipping/replace-placeholders-prometheus.html}

##### Start Telegraf
### Start Telegraf

{@include: ../_include/metric-shipping/telegraf-run.md}

##### Check Logz.io for your metrics
### Check Logz.io for your metrics

Give your data some time to get from your system to ours, then log in to your Logz.io Metrics account, and open [the Logz.io Metrics tab](https://app.logz.io/#/dashboard/metrics/).

Expand Down
15 changes: 6 additions & 9 deletions docs/shipping/apache-aurora.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,21 +13,18 @@ metrics_dashboards: []
metrics_alerts: []
---


## Overview

Apache Aurora is a Mesos framework for long-running services and cron jobs. Telegraf is a plug-in driven server agent for collecting and sending metrics and events from databases, systems and IoT sensors.

To send your Prometheus-format Apache Aurora metrics to Logz.io, you need to add the **inputs.aurora** and **outputs.http** plug-ins to your Telegraf configuration file.

#### Configuring Telegraf to send your metrics data to Logz.io
## Configuring Telegraf to send your metrics data to Logz.io


##### Set up Telegraf v1.17 or higher
### Set up Telegraf v1.17 or higher

{@include: ../_include/metric-shipping/telegraf-setup.md}

##### Add the inputs.aurora plug-in
### Add the inputs.aurora plug-in

First you need to configure the input plug-in to enable Telegraf to scrape the Apache Aurora data from your hosts. To do this, add the following code to the configuration file:

Expand Down Expand Up @@ -62,16 +59,16 @@ The full list of data scraping and configuring options can be found [here](https
:::


##### Add the outputs.http plug-in
### Add the outputs.http plug-in

{@include: ../_include/metric-shipping/telegraf-outputs.md}
{@include: ../_include/general-shipping/replace-placeholders-prometheus.html}

##### Start Telegraf
### Start Telegraf

{@include: ../_include/metric-shipping/telegraf-run.md}

##### Check Logz.io for your metrics
### Check Logz.io for your metrics

Give your data some time to get from your system to ours, then log in to your Logz.io Metrics account, and open [the Logz.io Metrics tab](https://app.logz.io/#/dashboard/metrics/).

Expand Down
24 changes: 11 additions & 13 deletions docs/shipping/apache-cassandra.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: Apache-Cassandra
title: Apache Cassandra
overview: Apache Cassandra is an open source NoSQL distributed database management system designed to process large amounts of data across commodity servers.Telegraf is a plug-in driven server agent for collecting and sending metrics and events from databases, systems and IoT sensors.
overview: Apache Cassandra is an open source NoSQL distributed database management system designed to process large amounts of data across commodity servers.
product: ['metrics']
os: ['windows', 'linux']
filters: ['Database']
Expand All @@ -13,8 +13,6 @@ metrics_dashboards: ["5oCUt52hGJu6LmVGHPOktr", "6J2RujMalRK3oC4y0r88ax"]
metrics_alerts: []
---

## Overview

[Apache Cassandra](https://cassandra.apache.org/) is an open source NoSQL distributed database management system designed to process large amounts of data across commodity servers.

Telegraf is a plug-in driven server agent for collecting and sending metrics and events from databases, systems and IoT sensors.
Expand All @@ -23,11 +21,11 @@ To send your JMX-format Apache Cassandra metrics to Logz.io, you need to add the

<!-- logzio-inject:install:grafana:dashboards ids=["5oCUt52hGJu6LmVGHPOktr", "6J2RujMalRK3oC4y0r88ax"] -->

#### Configuring Telegraf to send your metrics data to Logz.io
## Configuring Telegraf to send your metrics data to Logz.io



##### Install Jolokia agent on your Cassandra server
### Install Jolokia agent on your Cassandra server

:::note
You need to install and enable Jolokia on every Cassandra server.
Expand All @@ -40,25 +38,25 @@ Download Jolokia agent to `/usr/share/java`:
RUN curl -L http://search.maven.org/remotecontent?filepath=org/jolokia/jolokia-jvm/1.6.0/jolokia-jvm-1.6.0-agent.jar
```

##### Enable Jolokia agent on your Cassandra server
### Enable Jolokia agent on your Cassandra server

```shell
JVM_OPTS="$JVM_OPTS -javaagent:/usr/share/java/jolokia-jvm-1.6.0-agent.jar=port=8778,host=localhost"
```

##### Restart Cassandra
### Restart Cassandra

```shell
sudo service cassandra restart
```

##### Verify Jolokia is accessible
### Verify Jolokia is accessible

```shell
curl http://localhost:8778/jolokia/
```

##### Set up Telegraf v1.17 or higher on your Cassandra server
### Set up Telegraf v1.17 or higher on your Cassandra server

:::note
You need to install Telegraf on every Cassandra server.
Expand All @@ -68,7 +66,7 @@ You need to install Telegraf on every Cassandra server.

{@include: ../_include/metric-shipping/telegraf-setup.md}

##### Add the inputs.jolokia2_agent plug-in
### Add the inputs.jolokia2_agent plug-in

First you need to configure the input plug-in to enable Telegraf to scrape the Apache Cassandra data from your hosts. To do this, add the following code to the configuration file:

Expand Down Expand Up @@ -160,16 +158,16 @@ The full list of data scraping and configuring options can be found [here](https
:::


##### Add the outputs.http plug-in
### Add the outputs.http plug-in

{@include: ../_include/metric-shipping/telegraf-outputs.md}
{@include: ../_include/general-shipping/replace-placeholders-prometheus.html}

##### Start Telegraf
### Start Telegraf

{@include: ../_include/metric-shipping/telegraf-run.md}

##### Check Logz.io for your metrics
### Check Logz.io for your metrics

{@include: ../_include/metric-shipping/custom-dashboard.html} Install the pre-built dashboard to enhance the observability of your metrics.

Expand Down
14 changes: 6 additions & 8 deletions docs/shipping/apache-couchdb.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
id: apache-couchdb
title: Apache CouchDB
overview: Apache CouchDB is an open-source document-oriented NoSQL database, implemented in Erlang. Telegraf is a plug-in driven server agent for collecting and sending metrics and events from databases, systems and IoT sensors.
overview: Apache CouchDB is an open-source document-oriented NoSQL database, implemented in Erlang.
product: ['metrics']
os: ['windows', 'linux']
filters: ['Data Store']
Expand All @@ -14,21 +14,19 @@ metrics_alerts: []
---


## Overview

Apache CouchDB is an open-source document-oriented NoSQL database, implemented in Erlang. Telegraf is a plug-in driven server agent for collecting and sending metrics and events from databases, systems and IoT sensors.

To send your Prometheus-format CouchDB metrics to Logz.io, you need to add the **inputs.couchdb** and **outputs.http** plug-ins to your Telegraf configuration file.

#### Configuring Telegraf to send your metrics data to Logz.io
## Configuring Telegraf to send your metrics data to Logz.io



##### Set up Telegraf v1.17 or higher
### Set up Telegraf v1.17 or higher

{@include: ../_include/metric-shipping/telegraf-setup.md}

##### Add the inputs.couchdb plug-in
### Add the inputs.couchdb plug-in

First you need to configure the input plug-in to enable Telegraf to scrape the CouchDB data from your hosts. To do this, add the following code to the configuration file:

Expand All @@ -49,12 +47,12 @@ The database name is only required for instantiating a connection with the serve
:::


##### Add the outputs.http plug-in
### Add the outputs.http plug-in

{@include: ../_include/metric-shipping/telegraf-outputs.md}
{@include: ../_include/general-shipping/replace-placeholders-prometheus.html}

##### Check Logz.io for your metrics
### Check Logz.io for your metrics

Give your data some time to get from your system to ours, then log in to your Logz.io Metrics account, and open [the Logz.io Metrics tab](https://app.logz.io/#/dashboard/metrics/).

Expand Down
Loading