diff --git a/docs/config/dests.md b/docs/config/dests.md index bca423b..ebdfe8f 100644 --- a/docs/config/dests.md +++ b/docs/config/dests.md @@ -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=` -| 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`
* `channel` | | https://camel.apache.org/components/3.22.x/slack-component.html | -| `fluentd` | Send data to FluentD | * `tag`
* `host`
* `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`
* `subject`
* `to`
* `from` | * `port` | https://camel.apache.org/components/3.22.x/mail-component.html | -| `sentry` | Send data into Sentry | * `dsn` | | | -| `twilio` | Send via SMS | * `sid`
* `token`
* `to`
* `from` | | https://camel.apache.org/components/3.22.x/twilio-component.html | -| `loki` | Send data into Grafana Loki | * `url`
* `username`
* `password`
| * `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.
* `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`
* `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`
* `brokerURL` | https://camel.apache.org/components/3.22.x/activemq-component.html | -| `splunk-hec` | Send data to Splunk | * `splunkUrl`
* `token`
* `index` | * `skipTlsVerify` | https://camel.apache.org/components/3.22.x/splunk-hec-component.html | -| `pagerduty` | Send data to PagerDuty | * `routingKey` | * `component`
* `group`
* `class` | | -| `mezmo` | Send data to Mezmo | * `apiKey` | * `tags`
* `app` | | -| `elasticsearch` | Send data to Elasticsearch | * `endpoint`
* `apiKey`
* `index` | | | -| `otlp` | Send data to OpenTelemetry server | * `url` | * `errorRegex` | | -| `prometheus` | Expose metrics for Prometheus | None. | * `port` (default: 9090)
* `path` (default: /metrics)
* `metricPrefix` (default: manzan_)
* `username`
* `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`
* `channel` | | https://camel.apache.org/components/3.22.x/slack-component.html | +| `fluentd` | Send data to FluentD | * `tag`
* `host`
* `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`
* `subject`
* `to`
* `from` | * `port` | https://camel.apache.org/components/3.22.x/mail-component.html | +| `sentry` | Send data into Sentry | * `dsn` | | | +| `twilio` | Send via SMS | * `sid`
* `token`
* `to`
* `from` | | https://camel.apache.org/components/3.22.x/twilio-component.html | +| `loki` | Send data into Grafana Loki | * `url`
* `username`
* `password`
| * `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.
* `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`
* `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`
* `brokerURL` | https://camel.apache.org/components/3.22.x/activemq-component.html | +| `splunk-hec` | Send data to Splunk | * `splunkUrl`
* `token`
* `index` | * `skipTlsVerify` | https://camel.apache.org/components/3.22.x/splunk-hec-component.html | +| `pagerduty` | Send data to PagerDuty | * `routingKey` | * `component`
* `group`
* `class` | | +| `mezmo` | Send data to Mezmo | * `apiKey` | * `tags`
* `app` | | +| `elasticsearch` | Send data to Elasticsearch | * `endpoint`
* `apiKey`
* `index` | | | +| `otlp` | Send data to OpenTelemetry server | * `url` | * `errorRegex` | | +| `prometheus` | Expose metrics for Prometheus | None. | * `port` (default: 9090)
* `path` (default: /metrics)
* `metricPrefix` (default: manzan_)
* `username`
* `password` | [Prometheus Documentation](examples/prometheus.md) | +| `kafka` | Send to Kafka message broker | * `type`
* `topic`
* `brokers` | | | + + ### Example ```ini @@ -145,4 +147,9 @@ path=/metrics metricPrefix=ibmi_ username=prometheus password=secret + +[kafka] +type=kafka +topic=test_me +broker= ``` diff --git a/docs/install.md b/docs/install.md index f79aa8c..3e3e073 100644 --- a/docs/install.md +++ b/docs/install.md @@ -31,13 +31,13 @@ Manzan has support for all CCSIDs on IBM i. What this means is that when you dec java -jar ``` -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.