Update wiki Home page for log-sink

gitea_admin 2026-03-11 14:38:37 +00:00
parent 3a0063a79c
commit 6379547719

43
Home.md

@ -1,21 +1,36 @@
# Deploy the Project on CamelX Platform
# Log Sink
Deploy on CamelX Platform in three steps
A sink that logs all data that it receives, useful for debugging purposes.
## Step 1: Create a release
From the project space, click on **"Create a release"**
## Metadata
The new version is automatically available in the list
| Property | Value |
|----------|-------|
| Type | sink |
| Group | Logging |
| Namespace | Logging |
| Support Level | Stable |
| Provider | Apache Software Foundation |
## Step 2: Deploy
Click on **"Deploy"**
## Properties
- **Version:** Select the desired release
- **Environment:** Choose `Development`, `Staging`, or `Production`
- **Configuration:** Select the configuration source
- **Resources:** Set CPU and Memory
| Name | Type | Required | Default | Description |
|------|------|----------|---------|-------------|
| `loggerName` | string | | `log-sink` | Name of the logging category to use |
| `level` | string | | `INFO` | Logging level to use |
| `logMask` | boolean | | `false` | Mask sensitive information like password or passphrase in the log |
| `marker` | string | | | An optional Marker name to use |
| `multiline` | boolean | | `false` | If enabled then each information is outputted on a newline |
| `showAllProperties` | boolean | | `false` | Show all of the exchange properties (both internal and custom) |
| `showBody` | boolean | | `true` | Show the message body |
| `showBodyType` | boolean | | `true` | Show the body Java type |
| `showExchangePattern` | boolean | | `true` | Shows the Message Exchange Pattern (or MEP for short) |
| `showHeaders` | boolean | | `false` | Show the headers received |
| `showProperties` | boolean | | `false` | Show the exchange properties (only custom). Use showAllProperties to show both internal and custom properties. |
| `showStreams` | boolean | | `false` | Show the stream bodies (they may not be available in following steps) |
| `showCachedStreams` | boolean | | `true` | Whether Camel should show cached stream bodies or not. |
## Step 3: Expose
Enable **"Expose"**
## Dependencies
Choose an **API Gateway** (Internal, Public, etc.)
- `camel:kamelet`
- `camel:log`