Log Sink

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

A sink that logs all data that it receives, useful for debugging purposes.

Configuration Options

The following table summarizes the configuration options available for the log-sink Kamelet:

Property	Name	Description	Type	Default
level	Log Level	Logging level to use. Enum values: * TRACE * DEBUG * INFO * WARN * ERROR * OFF	string	INFO
logMask	Log Mask	Mask sensitive information like password or passphrase in the log.	boolean	false
loggerName	Logger Name	Name of the logging category to use.	string	log-sink
marker	Marker	An optional Marker name to use.	string
multiline	Multiline	If enabled then each information is outputted on a newline.	boolean	false
showAllProperties	Show All Properties	Show all of the exchange properties (both internal and custom).	boolean	false
showBody	Show Body	Show the message body.	boolean	true
showBodyType	Show Body Type	Show the body Java type.	boolean	true
showCachedStreams	Show Cached Streams	Whether Camel should show cached stream bodies or not.	boolean	true
showExchangePattern	Show Exchange Pattern	Shows the Message Exchange Pattern (or MEP for short).	boolean	true
showHeaders	Show Headers	Show the headers received.	boolean	false
showProperties	Show Properties	Show the exchange properties (only custom). Use showAllProperties to show both internal and custom properties.	boolean	false
showStreams	Show Streams	Show the stream bodies (they may not be available in following steps).	boolean	false

Property

Name

Description

Type

Default

Example

level

Log Level

Logging level to use.

Enum values:

* TRACE * DEBUG * INFO * WARN * ERROR * OFF

string

INFO

logMask

Log Mask

Mask sensitive information like password or passphrase in the log.

boolean

false

loggerName

Logger Name

Name of the logging category to use.

string

log-sink

marker

Marker

An optional Marker name to use.

string

multiline

Multiline

If enabled then each information is outputted on a newline.

boolean

false

showAllProperties

Show All Properties

Show all of the exchange properties (both internal and custom).

boolean

false

showBody

Show Body

Show the message body.

boolean

true

showBodyType

Show Body Type

Show the body Java type.

boolean

true

showCachedStreams

Show Cached Streams

Whether Camel should show cached stream bodies or not.

boolean

true

showExchangePattern

Show Exchange Pattern

Shows the Message Exchange Pattern (or MEP for short).

boolean

true

showHeaders

Show Headers

Show the headers received.

boolean

false

showProperties

Show Properties

Show the exchange properties (only custom). Use showAllProperties to show both internal and custom properties.

boolean

false

showStreams

Show Streams

Show the stream bodies (they may not be available in following steps).

boolean

false

Dependencies

At runtime, the log-sink Kamelet relies upon the presence of the following dependencies:

camel:kamelet
camel:log

Camel JBang usage

Prerequisites

You’ve installed JBang.
You have executed the following command:

jbang app install camel@apache/camel

Supposing you have a file named route.yaml with this content:

- route:
    from:
      uri: "kamelet:timer-source"
      parameters:
        period: 10000
        message: 'test'
      steps:
        - to:
            uri: "kamelet:log-sink"

You can now run it directly through the following command

camel run route.yaml

Camel K Environment Usage

This section describes how you can use the log-sink.

Knative sink

You can use the log-sink Kamelet as a Knative sink by binding it to a Knative object.

log-sink-pipe.yaml

apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: log-sink-pipe
spec:
  source:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: log-sink

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

Save the log-sink-pipe.yaml file to your local drive, and then edit it as needed for your configuration.
Run the sink by using the following command:
```
kubectl apply -f log-sink-pipe.yaml
```

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

kamel bind channel:mychannel  log-sink

This command creates the Kamelet Pipe in the current namespace on the cluster.

Kafka sink

You can use the log-sink Kamelet as a Kafka sink by binding it to a Kafka topic.

log-sink-pipe.yaml

apiVersion: camel.apache.org/v1
kind: Pipe
metadata:
  name: log-sink-pipe
spec:
  source:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: log-sink

Prerequisites

You’ve installed Strimzi.
You’ve created a topic named my-topic in the current namespace.
You have Camel K installed on the cluster.

Procedure for using the cluster CLI

Save the log-sink-pipe.yaml file to your local drive, and then edit it as needed for your configuration.
Run the sink by using the following command:
```
kubectl apply -f log-sink-pipe.yaml
```

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

kamel bind kafka.strimzi.io/v1beta1:KafkaTopic:my-topic  log-sink

This command creates the Kamelet Pipe in the current namespace on the cluster.

Kamelet source file

https://github.com/apache/camel-kamelets/blob/main/kamelets/log-sink.kamelet.yaml