Skip to content

Update documentation #276

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.

Sign up for GitHub

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

Open
legnerbeer wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update documentation #276

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1e7fe8
Update to v0.0.15 and add destination kafka
legnerbeer Jun 24, 2026
ac311dc
Update to v0.0.15 and add destination kafka
legnerbeer Jun 24, 2026
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
47 changes: 27 additions & 20 deletions docs/config/dests.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,26 +22,28 @@ Some types have additional properties that they require. Note, to specify a prop
you need to prefix the property with `componentOptions.` in your dest.ini configuration file. For example, to specify the option [brokerURL](https://camel.apache.org/components/3.22.x/activemq-component.html#_component_option_brokerURL)
for ActiveMQ, you should write the option as `componentOptions.brokerURL=<yourActiveMQUrl>`

| id | Description | Required properties | Commonly used properties | All properties
|------------------|---------------------------------|------------------------------------------------------------| -------------------------------------------------------- |----------------------------------------------------------------------|
| `stdout` | Write all data to standard out. | None. | | https://camel.apache.org/components/3.22.x/stream-component.html |
| `slack` | Send data to a Slack channel | * `webhook` <br> * `channel` | | https://camel.apache.org/components/3.22.x/slack-component.html |
| `fluentd` | Send data to FluentD | * `tag` <br> * `host` <br> * `port` | | |
| `file` | Send data to a file | * `file` | | https://camel.apache.org/components/3.22.x/stream-component.html |
| `dir` | Send data to a directory | * `dir` | | https://camel.apache.org/components/3.22.x/file-component.html |
| `smtp`/`smtps` | Sent data via email | * `server` <br> * `subject` <br> * `to` <br> * `from` | * `port` | https://camel.apache.org/components/3.22.x/mail-component.html |
| `sentry` | Send data into Sentry | * `dsn` | | |
| `twilio` | Send via SMS | * `sid` <br> * `token` <br> * `to` <br> * `from` | | https://camel.apache.org/components/3.22.x/twilio-component.html |
| `loki` | Send data into Grafana Loki | * `url` <br> * `username` <br> * `password` <br> | * `maxLabels` The maximum number of indexed labels each log record can have. The default is 15. If you want to use more than 15 labels, you must also configure this separately on your Grafana Loki instance. However, this is not recommended as it will degrade performance. <br> * `labels` specifies the labels to be associated with each log record. Each label should be delimited by a space. I.e `labels=REMOTE_PORT SYSTEM_NAME` (In this case `REMOTE_PORT` and `SYSTEM_NAME` should be valid format options on the data source. For example if using Audit Password events). It is strongly recommended to specify this property, because the default option is to add labels for each data attribute that is received. | |
| `http`/`https` | Send data via http/https | * `url` | * `httpMethod` <br> * `x` where x is any query parameter | https://camel.apache.org/components/3.22.x/http-component.html |
| `activemq` | Send data to ActiveMQ | * `destinationName` | * `destinationType` <br> * `brokerURL` | https://camel.apache.org/components/3.22.x/activemq-component.html |
| `splunk-hec` | Send data to Splunk | * `splunkUrl` <br> * `token` <br> * `index` | * `skipTlsVerify` | https://camel.apache.org/components/3.22.x/splunk-hec-component.html |
| `pagerduty` | Send data to PagerDuty | * `routingKey` | * `component` <br> * `group` <br> * `class` | |
| `mezmo` | Send data to Mezmo | * `apiKey` | * `tags` <br> * `app` | |
| `elasticsearch` | Send data to Elasticsearch | * `endpoint` <br> * `apiKey` <br> * `index` | | |
| `otlp` | Send data to OpenTelemetry server | * `url` | * `errorRegex` | |
| `prometheus` | Expose metrics for Prometheus | None. | * `port` (default: 9090) <br> * `path` (default: /metrics) <br> * `metricPrefix` (default: manzan_) <br> * `username` <br> * `password` | [Prometheus Documentation](examples/prometheus.md) |

| id | Description | Required properties | Commonly used properties | All properties
|------------------|-----------------------------------|-------------------------------------------------------| -------------------------------------------------------- |----------------------------------------------------------------------|
| `stdout` | Write all data to standard out. | None. | | https://camel.apache.org/components/3.22.x/stream-component.html |
| `slack` | Send data to a Slack channel | * `webhook` <br> * `channel` | | https://camel.apache.org/components/3.22.x/slack-component.html |
| `fluentd` | Send data to FluentD | * `tag` <br> * `host` <br> * `port` | | |
| `file` | Send data to a file | * `file` | | https://camel.apache.org/components/3.22.x/stream-component.html |
| `dir` | Send data to a directory | * `dir` | | https://camel.apache.org/components/3.22.x/file-component.html |
| `smtp`/`smtps` | Sent data via email | * `server` <br> * `subject` <br> * `to` <br> * `from` | * `port` | https://camel.apache.org/components/3.22.x/mail-component.html |
| `sentry` | Send data into Sentry | * `dsn` | | |
| `twilio` | Send via SMS | * `sid` <br> * `token` <br> * `to` <br> * `from` | | https://camel.apache.org/components/3.22.x/twilio-component.html |
| `loki` | Send data into Grafana Loki | * `url` <br> * `username` <br> * `password` <br> | * `maxLabels` The maximum number of indexed labels each log record can have. The default is 15. If you want to use more than 15 labels, you must also configure this separately on your Grafana Loki instance. However, this is not recommended as it will degrade performance. <br> * `labels` specifies the labels to be associated with each log record. Each label should be delimited by a space. I.e `labels=REMOTE_PORT SYSTEM_NAME` (In this case `REMOTE_PORT` and `SYSTEM_NAME` should be valid format options on the data source. For example if using Audit Password events). It is strongly recommended to specify this property, because the default option is to add labels for each data attribute that is received. | |
| `http`/`https` | Send data via http/https | * `url` | * `httpMethod` <br> * `x` where x is any query parameter | https://camel.apache.org/components/3.22.x/http-component.html |
| `activemq` | Send data to ActiveMQ | * `destinationName` | * `destinationType` <br> * `brokerURL` | https://camel.apache.org/components/3.22.x/activemq-component.html |
| `splunk-hec` | Send data to Splunk | * `splunkUrl` <br> * `token` <br> * `index` | * `skipTlsVerify` | https://camel.apache.org/components/3.22.x/splunk-hec-component.html |
| `pagerduty` | Send data to PagerDuty | * `routingKey` | * `component` <br> * `group` <br> * `class` | |
| `mezmo` | Send data to Mezmo | * `apiKey` | * `tags` <br> * `app` | |
| `elasticsearch` | Send data to Elasticsearch | * `endpoint` <br> * `apiKey` <br> * `index` | | |
| `otlp` | Send data to OpenTelemetry server | * `url` | * `errorRegex` | |
| `prometheus` | Expose metrics for Prometheus | None. | * `port` (default: 9090) <br> * `path` (default: /metrics) <br> * `metricPrefix` (default: manzan_) <br> * `username` <br> * `password` | [Prometheus Documentation](examples/prometheus.md) |
| `kafka` | Send to Kafka message broker | * `type` <br> * `topic` <br> * `brokers` | | |


### Example

```ini
Expand Down Expand Up @@ -145,4 +147,9 @@ path=/metrics
metricPrefix=ibmi_
username=prometheus
password=secret

[kafka]
type=kafka
topic=test_me
broker=<YOUR_IP:PORT>
```
6 changes: 3 additions & 3 deletions docs/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,13 @@ Manzan has support for all CCSIDs on IBM i. What this means is that when you dec
java -jar <name of jar file>
```

For instance, to install version `0.0.9`, the steps from an IBM i (using open source `wget`) would look like:
For instance, to install version `0.0.15`, the steps from an IBM i (using open source `wget`) would look like:

```bash
mkdir -p /opt/download
cd /opt/download
wget https://github.com/ThePrez/Manzan/releases/download/v0.0.9/manzan-installer-v0.0.9.jar
java -jar manzan-installer-v0.0.9.jar
wget https://github.com/ThePrez/Manzan/releases/download/v0.0.15/manzan-installer-v0.0.15.jar
java -jar manzan-installer-v0.0.15.jar
```

Note: There is currently a bug in the installer where it might say `ERROR: Error running command` after the install is completed.
Expand Down