Skip to content

Commit

Permalink
Move examples folder (#537)
Browse files Browse the repository at this point in the history
* moved examples folder to docs

* fixed links to examples folder
  • Loading branch information
asenkowski authored Feb 3, 2022
1 parent 85692c7 commit 7065476
Show file tree
Hide file tree
Showing 33 changed files with 25 additions and 25 deletions.
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ sh -c "$(curl -fsSlL https://github.com/observiq/stanza/releases/latest/download
```

### Kubernetes
To deploy Stanza to Kubernetes, AKS, EKS, GKE or Openshift check out the installation guides [here](./examples/k8s).
To deploy Stanza to Kubernetes, AKS, EKS, GKE or Openshift check out the installation guides [here](/docs/examples/k8s).

## Configuration

Expand All @@ -66,18 +66,18 @@ To get started navigate to the `config.yaml` file in the Stanza install director
- MacOS: `/Users/<user>/observiq/stanza`
- Windows: `C:\observiq\stanza`

You can utilize [operators](./docs/operators/README.md) and [plugins](./docs/plugins.md) in a pipeline to easily configure Stanza to ship logs to your target destination.
You can utilize [operators](/docs/operators/README.md) and [plugins](/docs/plugins.md) in a pipeline to easily configure Stanza to ship logs to your target destination.

Stanza also offers several outputs to be configured for sending data, including:

- [Stdout](./docs/operators/stdout.md)
- [File](./docs/operators/file_output.md)
- [Google Cloud Logging](./docs/operators/google_cloud_output.md)
- [Stdout](/docs/operators/stdout.md)
- [File](/docs/operators/file_output.md)
- [Google Cloud Logging](/docs/operators/google_cloud_output.md)

In the below examples, Stanza is configured to ship logs to Google Cloud logging using the file_input operator, and the MySQL plugin. You will need to have a `credentials.json` for your GCP environment which can be generated by following Google's documentation [here](https://cloud.google.com/iam/docs/creating-managing-service-account-keys).

### Operators
This `config.yaml` collects logs from a file and sends them to Google Cloud. A full list of available operators can be found [here](./docs/operators/README.md).
This `config.yaml` collects logs from a file and sends them to Google Cloud. A full list of available operators can be found [here](/docs/operators/README.md).

```yaml
pipeline:
Expand Down Expand Up @@ -112,21 +112,21 @@ pipeline:

That's it! Logs should be streaming to Google Cloud.

For more details on installation and configuration, check out our full [Install Guide](./docs/README.md)!
For more details on installation and configuration, check out our full [Install Guide](/docs/README.md)!

### Common Scenarios

To see specific examples of Stanza configuration, check out the [scenarios](./examples/scenarios). Below are some of our more popular scenarios:
To see specific examples of Stanza configuration, check out the [scenarios](/docs/examples/scenarios). Below are some of our more popular scenarios:

- [Syslog](./examples/scenarios/syslog.md)
- [MySQL](./examples/scenarios/mysql.md)
- [Windows Events](./examples/scenarios/windows_events.md)
- [File](./examples/scenarios/file.md)
- [Custom Parsing](./examples/scenarios/custom_parsing.md)
- [Syslog](/docs/examples/scenarios/syslog.md)
- [MySQL](/docs/examples/scenarios/mysql.md)
- [Windows Events](/docs/examples/scenarios/windows_events.md)
- [File](/docs/examples/scenarios/file.md)
- [Custom Parsing](/docs/examples/scenarios/custom_parsing.md)

# Community

Stanza is an open source project. If you'd like to contribute, take a look at our [contribution guidelines](./CONTRIBUTING.md) and [developer guide](./docs/development.md). We look forward to building with you.
Stanza is an open source project. If you'd like to contribute, take a look at our [contribution guidelines](/CONTRIBUTING.md) and [developer guide](/docs/development.md). We look forward to building with you.

## Code of Conduct

Expand Down
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ sh -c "$(curl -fsSlL https://github.com/observiq/stanza/releases/latest/download
```

### Kubernetes
For Kubernetes, there are several guides to install and configure Stanza found [here](./examples/k8s).
For Kubernetes, there are several guides to install and configure Stanza found [here](/docs/examples/k8s).

## Manual Installation

Expand Down Expand Up @@ -197,7 +197,7 @@ pipeline:
credentials_file: /tmp/credentials.json
```

ALternatively, you can use a plugin for log monitoring. This `config.yaml` collects logs from MySQL via a plugin and sends them to Google Cloud. By default, MySQL plugin collects general, slow query, and error logs. More details of the MySQL plugin can be viewed [here](https://github.com/observIQ/stanza-plugins/blob/master/plugins/mysql.yaml).
Alternatively, you can use a plugin for log monitoring. This `config.yaml` collects logs from MySQL via a plugin and sends them to Google Cloud. By default, MySQL plugin collects general, slow query, and error logs. More details of the MySQL plugin can be viewed [here](https://github.com/observIQ/stanza-plugins/blob/master/plugins/mysql.yaml).

```yaml
pipeline:
Expand All @@ -222,4 +222,4 @@ That's it! You should have logs streaming to Google Cloud. From here you can exp
- Read up on how to write a stanza [pipeline](/docs/pipeline.md).
- Check out stanza's list of [operators](/docs/operators/README.md).
- Check out the [FAQ](/docs/faq.md).
- Let us know what you think! [Email us](mailto:stanza@observiqlabs.com), or open a GitHub issue.
- Let us know what you think! [Email us](mailto:support.stanza@observiq.com), or open a GitHub issue.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# File

Once you have Stanza installed and running from the [quickstart guide](./README.md#quick-start), you can follow these steps to configure a file to send logs via Stanza.
Once you have Stanza installed and running from the [quickstart guide](/README.md#quick-start), you can follow these steps to configure a file to send logs via Stanza.

## Prerequisites

Expand All @@ -18,7 +18,7 @@ On the host that Stanza will read logs from, make sure you know the location of
| `log_type` | `file` | Adds the specified 'Type' as a label to each log message. |
| `start_at` | `beginning` | Start reading file from 'beginning' or 'end' |

This is an example config file that can be used in the Stanza install directory, noted in the [Configuration](./README.md#Configuration) section of the quickstart guide. It uses a simple [file operator](/docs/operators/file_input.md) to send logs to Google Cloud utilizing a credentials file that can be generated following Google's documentation [here](https://cloud.google.com/iam/docs/creating-managing-service-account-keys).
This is an example config file that can be used in the Stanza install directory, noted in the [Configuration](/README.md#Configuration) section of the quickstart guide. It uses a simple [file operator](/docs/operators/file_input.md) to send logs to Google Cloud utilizing a credentials file that can be generated following Google's documentation [here](https://cloud.google.com/iam/docs/creating-managing-service-account-keys).

```yaml
pipeline:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MySQL

Once you have Stanza installed and running from the [quickstart guide](./README.md#quick-start), you can follow these steps to configure MySQL monitoring via Linux.
Once you have Stanza installed and running from the [quickstart guide](/README.md#quick-start), you can follow these steps to configure MySQL monitoring via Linux.

## Prerequisites

Expand Down Expand Up @@ -38,7 +38,7 @@ For more details, see the slow query log documentation [here](https://dev.mysql.
| `mariadb_audit_log_path` | `"/var/log/mysql/audit.log"` | Path to audit log file created by MariaDB plugin |
| `start_at` | `end` | Start reading file from 'beginning' or 'end' |

This is an example config file that can be used in the Stanza install directory, noted in the [Configuration](./README.md#Configuration) section of the quickstart guide. The MySQL plugin supports general, error, and slow query logs by default, but can also support MariaDB audit logs if those have been enabled.
This is an example config file that can be used in the Stanza install directory, noted in the [Configuration](/README.md#Configuration) section of the quickstart guide. The MySQL plugin supports general, error, and slow query logs by default, but can also support MariaDB audit logs if those have been enabled.

```yaml
pipeline:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Syslog

Once you have Stanza installed and running from the [quickstart guide](./README.md#quick-start), you can follow these steps to configure Syslog monitoring.
Once you have Stanza installed and running from the [quickstart guide](/README.md#quick-start), you can follow these steps to configure Syslog monitoring.

## Prerequisites

Expand Down Expand Up @@ -41,7 +41,7 @@ ufw allow 514
| `tls_private_key` | | Path to x509 PEM encoded TLS private key file |
| `tls_min_version` | `"1.2"` | Minimum TLS version to support (string) |

This is an example config file that can be used in the Stanza install directory, noted in the [Configuration](./README.md#Configuration) section of the quickstart guide. The Syslog plugin supports UDP and TCP logs, using UDP by default.
This is an example config file that can be used in the Stanza install directory, noted in the [Configuration](/README.md#Configuration) section of the quickstart guide. The Syslog plugin supports UDP and TCP logs, using UDP by default.

```yaml
pipeline:
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Windows Events

Once you have Stanza installed and running from the [quickstart guide](./README.md#quick-start), you can follow these steps to configure Windows Event monitoring via Stanza.
Once you have Stanza installed and running from the [quickstart guide](/README.md#quick-start), you can follow these steps to configure Windows Event monitoring via Stanza.

## Prerequisites

Expand All @@ -21,7 +21,7 @@ The Windows Events plugin can monitor custom channels in addition to the three c
| `poll_interval` | `1` | The interval, in seconds, at which the channel is checked for new log entries. This check begins again after all new records have been read |
| `start_at` | `end` | Start reading file from 'beginning' or 'end' |

This is an example config file that can be used in the Stanza install directory, noted in the [Configuration](./README.md#Configuration) section of the quickstart guide. The Windows Events plugin supports system, application, and security events by default, but can also support custom channels if those have been configured.
This is an example config file that can be used in the Stanza install directory, noted in the [Configuration](/README.md#Configuration) section of the quickstart guide. The Windows Events plugin supports system, application, and security events by default, but can also support custom channels if those have been configured.

```yaml
pipeline:
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 7065476

Please sign in to comment.