Red Hat build of Apache Camel のツールガイド

言語サポートエクステンションの重要な機能を以下に示します。

Apache Camel Language Server を使用する場合は、次の点を考慮する必要があります。

VS Code Extension Marketplace および Open VSX Registry から、Apache Camel エクステンションの Language サポートをダウンロードできます。Language Support for Apache Camel エクステンションを Microsoft VS Code に直接インストールすることもできます。

これにより、エディターに言語サポート拡張機能がインストールされます。

特定の Camel カタログバージョンを使用できます。File > Preferences > Settings > Apache Camel Tooling > Camel catalog version をクリックします。バージョン識別子に redhat が含まれる Red Hat 製品化バージョンの場合、Maven Red Hat リポジトリーが自動的に追加されます。

Apache Camel エクステンション用 VS Code デバッグアダプターは、次の機能をサポートしています。

Apache Camel 拡張機能用の VS Code デバッグアダプターを使用する場合は、次の点を考慮する必要があります。

Apache Camel エクステンションの VS Code Debug Adapter は、VS Code Extension Marketplace および Open VSX Registry からダウンロードできます。Debug Adapter for Apache Camel 拡張機能を Microsoft VS Code に直接インストールすることもできます。

これにより、VS Code エディターに Apache Camel のデバッグアダプターがインストールされます。

デバッグアダプターを使用して Camel アプリケーションをデバッグできます。

Camel CLI の config コマンドは、ユーザー設定を保存および使用するために使用します。これにより、毎回 CLI オプションを指定する必要がなくなります。たとえば、別の Camel バージョンを実行するには、次を使用します。

camel run * --camel-version=4.8.3.redhat-00004

camel-version は次のようなユーザー設定に追加できます。

camel config set camel-version=4.8.3.redhat-00004

これは、camel run コマンドの使用時に使用される Camel バージョンを設定します。以下の run コマンドはユーザー設定を使用します。

camel run *

ユーザー設定ファイルは ~/.camel-jbang-user.properties に保存されます。

Camel CLI は、すぐに bash および zsh のシェル補完を提供します。Camel CLI のシェル補完を有効にするには、次を実行します。

source <(camel completion)

これを永続的にするには、次を実行します。

echo 'source <(camel completion)' >> ~/.bashrc

たとえば、2 つの YAML ファイルを実行するなど、複数のファイルからルートを実行できます。

camel run one.yaml two.yaml

yaml と Java などの 2 つの異なるファイルからルートを実行できます。

camel run one.yaml hello.java

ワイルドカード (つまり *) を使用して、すべての yaml ファイルを実行するなど、複数のファイルに一致させることができます。

camel run *.yaml

foo* で始まるすべてのファイルを実行できます。

camel run foo*

ディレクトリー内のすべてのファイルを実行するには、次を使用します。

camel run *

非常に小さな Java ルートの場合、以下に示すように、ルートを CLI 引数として指定できます。

camel run --code='from("kamelet:beer-source").to("log:beer")'

CLI 引数はファイルよりも使用が少し面倒であるため、これは非常に制限されています。入力パラメーターからルートを実行する場合は、以下の点に留意してください。

次に示すように --dev オプションを使用して、ソースファイルの更新 (保存) 時にルートのライブリロードに伴う開発モードを有効にできます。

camel run foo.yaml --dev

Camel インテグレーションの実行中に、YAML ルートを更新し、保存時に更新できます。このオプションは、java を含むすべての DLS で機能します。次に例を示します。

camel run hello.java --dev

開発者にさまざまな情報を表示する開発者コンソールを有効にすることができます。開発者コンソールを有効にするには、次を実行します。

camel run hello.java --console

これにより、Web ブラウザーから http://localhost:8080/q/dev (デフォルト) にあるコンソールにアクセスできるようになります。このリンクは、Camel の起動時にログにも表示されます。

コンソールでは、メッセージの処理に最も時間がかかる上位ルートのレポートなど、実行中の Camel インテグレーションに関する洞察を得ることができます。その後、これらのルート内で最も時間がかかっている EIP を個別に特定できます。

開発者コンソールはデータを JSON 形式で出力することもでき、サードパーティーのツールで情報を取得するために使用できます。たとえば、curl 経由で上位のルートを出力するには、次を実行します。

curl -s -H "Accept: application/json"  http://0.0.0.0:8080/q/dev/top/

JSON データをカラーでフォーマットして出力できる jq がインストールされている場合は、次を実行します。

curl -s -H "Accept: application/json"  http://0.0.0.0:8080/q/dev/top/ | jq

Camel CLI の profile は Camel CLI で自動的にロードされる設定を参照する名前 (ID) です。デフォルトのプロファイルは、application という名前が付けられ、これは (スマートデフォルト) で Camel CLI が application.properties (存在する場合) を自動的にロードできるようにします。これは、同じ名前の特定のプロパティーファイルに一致するプロファイルを作成できることを意味します。

たとえば、local という名前のプロファイルを使用して実行すると、Camel CLI は application.properties の代わりに local.properties をロードします。プロファイルを使用するには、次のようにコマンドラインオプション --profile を指定します。

camel run hello.java --profile=local

一度に指定できるプロファイル名は 1 つだけです。たとえば、--profile=local,two は無効です。

properties ファイルでは、Camel Main のすべての設定を行えます。ログマスキングをオフにして有効にするには、次のコマンドを実行します。

camel.main.streamCaching=false
camel.main.logMask=true

また、camel-kafka などの Camel コンポーネントを設定して、URL をブローカーに宣言することもできます。

camel.component.kafka.brokers=broker1:9092,broker2:9092,broker3:9092

デフォルトでは、Camel CLI は Camel の実行に必要な依存関係を自動的に解決します。これは、JBang と Camel によってそれぞれ実行されます。Camel 自体は、クラスパス上で現在利用できない JAR がコンポーネントに必要かどうかを実行時に検出し、JAR を自動的にダウンロードできます。

Camel はこれらの JAR を次の順序でダウンロードします。

Camel CLI をインターネット経由でダウンロードしない場合は、次のように --download オプションを使用してこれをオフにできます。

camel run foo.java --download=false

Camel CLI は、独自のリリースからの Camel コンポーネント、言語、データ形式の依存関係を自動的に検出します。これは、使用する JAR を指定する必要がないことを意味します。ただし、サードパーティーのカスタム JAR を追加する必要がある場合は、次のように、Maven GAV 構文 (groupId:artifactId:version) の CLI 引数として --dep を使用してこれらを指定できます。

camel run foo.java --dep=com.foo:acme:1.0

To add a Camel dependency explicitly you can use a shorthand syntax (starting with `camel:` or `camel-`):

camel run foo.java --dep=camel-saxon

複数の依存関係をコンマで区切って指定できます。

camel run foo.java --dep=camel-saxon,com.foo:acme:1.0

Camel CLI は、まずローカルリポジトリーからダウンロードし、次にオンラインの Maven Central リポジトリーからダウンロードします。サードパーティーの Maven リポジトリーからダウンロードするには、これを CLI 引数として、または application.properties ファイルで指定する必要があります。

camel run foo.java --repos=https://packages.atlassian.com/maven-external

サードパーティーの Maven リポジトリーの設定は、次に示すように、camel.jbang.repos キーを使用して application.properties ファイルで設定されます。

camel.jbang.repos=https://packages.atlassian.com/maven-external

Camel ルートを実行すると、application.properties が自動的に読み込まれます。

camel run foo.java

使用するプロパティーファイルを明示的に指定することもできます。

camel run foo.java application.properties

または、これをプロファイルとして指定することもできます。

camel run foo.java --profile=application

ここで、プロファイル ID はプロパティーファイルの名前です。

デフォルトでは、既存の ~/.m2/settings.xml ファイルがロードされるため、Maven 解決プロセスの動作を変更することができます。Maven 設定ファイルは、Maven ミラー、認証情報設定 (暗号化される可能性がある)、またはアクティブなプロファイル、および追加のリポジトリーに関する情報を提供します。

Maven リポジトリーは認証を使用でき、Maven で認証情報を設定するには <server> 要素を使用します。

<server>
    <id>external-repository</id>
    <username>camel</username>
    <password>{SSVqy/PexxQHvubrWhdguYuG7HnTvHlaNr6g3dJn7nk=}</password>
</server>

パスワードはプレーンテキストを使用して指定できますが、最初に Maven マスターパスワードを設定してから、それを使用してリポジトリーパスワードを設定することを推奨します。

$ mvn -emp
Master password: camel
{hqXUuec2RowH8dA8vdqkF6jn4NU9ybOsDjuTmWvYj4U=}

上記のパスワードは、次のように ~/.m2/settings-security.xml ファイルに追加する必要があります。

<settingsSecurity>
  <master>{hqXUuec2RowH8dA8vdqkF6jn4NU9ybOsDjuTmWvYj4U=}</master>
</settingsSecurity>

その後、通常のパスワードを設定できます。

$ mvn -ep
Password: camel
{SSVqy/PexxQHvubrWhdguYuG7HnTvHlaNr6g3dJn7nk=}

その後、このパスワードを <server>/<password> 設定で使用できます。

デフォルトでは、Maven は ~/.m2/settings-security.xml ファイルからマスターパスワードを読み取りますが、これをオーバーライドすることもできます。settings.xml ファイル自体の場所は、次のように指定できます。

camel run foo.java --maven-settings=/path/to/settings.xml --maven-settings-security=/path/to/settings-security.xml

場所 (~/.m2/settings.xml であっても) を想定せずに Camel アプリケーションを実行したい場合は、このオプションを使用します。

camel run foo.java --maven-settings=false

Camels リソースローダーを使用して、GitHub でホストされているルートを実行できます。たとえば、Camel K サンプルの 1 つを実行するには、次を使用します。

camel run github:apache:camel-kamelets-examples:jbang/hello-java/Hey.java

GitHub の https URL を使用することもできます。たとえば、Web ブラウザーからサンプルを参照し、ブラウザーウィンドウから URL をコピーして、Camel CLI でサンプルを実行できます。

camel run https://github.com/apache/camel-kamelets-examples/tree/main/jbang/hello-java

すべての groovy ファイルを実行するなど、ワイルドカード (つまり \*) を使用して複数のファイルと一致させることもできます。

camel run https://github.com/apache/camel-kamelets-examples/tree/main/jbang/languages/*.groovy

または、rou* で始まるすべてのファイルを実行することもできます。

camel run https://github.com/apache/camel-kamelets-examples/tree/main/jbang/languages/rou*

camel run https://gist.github.com/davsclaus/477ddff5cdeb1ae03619aa544ce47e92

Camel CLI を使用すると、既存のサンプルを GitHub からローカルディスクにダウンロードできます。これにより、サンプルを変更してローカルで実行できるようになります。たとえば、次のコマンドを実行して dependency injection 例をダウンロードできます。

camel init https://github.com/apache/camel-kamelets-examples/tree/main/jbang/dependency-injection

次に、ファイル (サブフォルダーではなく) が現在のディレクトリーにダウンロードされます。次に、次のようにしてサンプルをローカルで実行できます。

camel run *

--directory オプションを使用してファイルを新しいフォルダーにダウンロードすることもできます。たとえば、ファイルを myproject という名前のフォルダーにダウンロードするには、次のコマンドを実行します。

camel init https://github.com/apache/camel-kamelets-examples/tree/main/jbang/dependency-injection --directory=myproject

この例を開発モードで実行して、ソースコードの変更をホットデプロイすることができます。

camel run * --dev

単一のファイルをダウンロードできます。たとえば、Camel K サンプルの 1 つをダウンロードするには、次を実行します。

camel init https://github.com/apache/camel-k-examples/blob/main/generic-examples/languages/simple.groovy

これは素晴らしいルートで、次のように実行できます (または * を使用します)。

camel run simple.groovy

camel init https://gist.github.com/davsclaus/477ddff5cdeb1ae03619aa544ce47e92

camel run *

camel init https://gist.github.com/davsclaus/477ddff5cdeb1ae03619aa544ce47e92 --directory=foobar

Camel は、CRD 形式 (Kubernetes カスタムリソース定義) の Camel K インテグレーションとバインディングファイルの実行をサポートしています。たとえば、joke.yaml という名前の kamelet バインディングファイルを実行するには、次のようにします。

#!/usr/bin/env jbang camel@apache/camel run
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: joke
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: chuck-norris-source
    properties:
      period: 2000
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: log-sink
    properties:
      show-headers: false

camel run joke.yaml

Camel ルートは OS クリップボードから直接実行できます。これにより、コードをコピーして、ルートをすぐに実行できます。

camel run clipboard.<extension>

ここで、<extension> は、クリップボードのコンテンツのタイプ (java、xml、yaml など) です。

たとえば、これをクリップボードにコピーして、ルートを実行できます。

<route>
  <from uri="timer:foo"/>
  <log message="Hello World"/>
</route>

camel run clipboard.xml

現在実行中の Camel インテグレーションをリスト表示するには、ps オプションを使用します。

camel ps
  PID   NAME                          READY  STATUS    AGE
 61818  sample.camel.MyCamelApplica…   1/1   Running  26m38s
 62506  test1                          1/1   Running   4m34s

これには、PID、インテグレーションの名前、経過時間がリストされます。

stop コマンドを使用すると、これらの実行中の Camel インテグレーションを停止できます。たとえば、test1 を停止するには、次を実行します。

camel stop test1
Stopping running Camel integration (pid: 62506)

PID を使用してインテグレーションを停止できます。

camel stop 62506
Stopping running Camel integration (pid: 62506)

すべてのインテグレーションを停止するには、次のように --all オプションを使用します。

camel stop --all
Stopping running Camel integration (pid: 61818)
Stopping running Camel integration (pid: 62506)

Camel CLI は、デフォルトでは、CLI を使用して実行されている Camel インテグレーション (camel run foo.java など) のみを制御します。

CLI が Quarkus アプリケーションを制御および管理できるようにするには、これらのプロジェクトに依存関係を追加して Camel CLI と統合する必要があります。

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-cli-connector</artifactId>
</dependency>

Camel CLI の get コマンドは、稼働中の Camel インテグレーションの 1 つまたはすべてに関する Camel 固有のステータスを取得するために使用されます。実行中の Camel インテグレーションの状態を表示するには、以下を実行します。

camel get
  PID   NAME      CAMEL            PLATFORM            READY  STATUS    AGE    TOTAL  FAILED  INFLIGHT  SINCE-LAST
 61818  MyCamel   3.20.1-SNAPSHOT  Quarkus v3.2         1/1   Running  28m34s    854       0         0     0s/0s/-
 63051  test1     3.20.1-SNAPSHOT  JBang                1/1   Running     18s     14       0         0     0s/0s/-
 63068  mygroovy  3.20.1-SNAPSHOT  JBang                1/1   Running      5s      2       0         0     0s/0s/-

camel get コマンドは、デフォルトのインテグレーションを表示します。これは、camel get integrations コマンドまたは camel get int コマンドの入力と同じです。

これにより、すべての Camel インテグレーションに関する全体的な情報が表示されます。ここでは、処理されたメッセージの合計数を確認できます。列 Since Last は、3 つのステージ (started/completed/failed) の最後の処理済みメッセージの前に時間を示します。

0s/ 0s/- の値は、最後に開始および完了したメッセージが発生したこと (0 秒前)、および失敗したメッセージがまだないことを意味します。この例では、9s/9s/1h3m は、最後に開始および完了したメッセージが 9 秒前に、最後の失敗は 1 時間、3 分前であることを意味します。

camel get route を使用したすべてのローカル Camel インテグレーションから、すべてのルートのステータスを確認することもできます。

camel get route
  PID   NAME      ID      FROM                        STATUS    AGE   TOTAL  FAILED  INFLIGHT  MEAN  MIN  MAX  SINCE-LAST
 61818  MyCamel   hello   timer://hello?period=2000   Running  29m2s    870       0         0     0    0   14     0s/0s/-
 63051  test1      java    timer://java?period=1000    Running    46s     46       0         0     0    0    9     0s/0s/-
 63068  mygroovy  groovy  timer://groovy?period=1000  Running    34s     34       0         0     0    0    5     0s/0s/-

camel top
  PID   NAME     JAVA     CAMEL            PLATFORM            STATUS    AGE         HEAP        NON-HEAP     GC     THREADS   CLASSES
 22104  chuck    11.0.13  3.20.1-SNAPSHOT  JBang               Running   2m10s  131/322/4294 MB  70/73 MB  17ms (6)      7/8  7456/7456
 14242  MyCamel  11.0.13  3.20.1-SNAPSHOT  Quarkus 32.         Running  33m40s  115/332/4294 MB  62/66 MB  37ms (6)    16/16  8428/8428
 22116  bar      11.0.13  3.20.1-SNAPSHOT  JBang               Running    2m7s   33/268/4294 MB  54/58 MB  20ms (4)      7/8  6104/6104

camel top route
  PID   NAME     ID                     FROM                                 STATUS    AGE    TOTAL  FAILED  INFLIGHT  MEAN  MIN  MAX  SINCE-LAST
 22104  chuck    chuck-norris-source-1  timer://chuck?period=10000           Started     10s      1       0         0   163  163  163          9s
 22116  bar      route1                 timer://yaml2?period=1000            Started      7s      7       0         0     1    0   11          0s
 22104  chuck    chuck                  kamelet://chuck-norris-source        Started     10s      1       0         0     0    0    0          9s
 22104  chuck    log-sink-2             kamelet://source?routeId=log-sink-2  Started     10s      1       0         0     0    0    0          9s
 14242  MyCamel  hello                  timer://hello?period=2000            Started  31m41s    948       0         0     0    0    4          0s

camel cmd stop-route chuck

camel get route
  PID   NAME     ID                     FROM                                 STATUS    AGE   TOTAL  FAILED  INFLIGHT  MEAN  MIN  MAX  SINCE-LAST
 81663  chuck    chuck                  kamelet://chuck-norris-source        Stopped           600       0         0     0    0    1          4s
 81663  chuck    chuck-norris-source-1  timer://chuck?period=10000           Stopped           600       0         0    65   52  290          4s
 81663  chuck    log-sink-2             kamelet://source?routeId=log-sink-2  Stopped           600       0         0     0    0    1          4s
 83415  bar      route1                 timer://yaml2?period=1000            Started  5m30s    329       0         0     0    0   10          0s
 83695  MyCamel  hello                  timer://hello?period=2000            Started  3m52s    116       0         0     0    0    9          1s

camel cmd start-route chuck

camel cmd stop-route --all

camel cmd start-route --all

camel cmd logger
  PID   NAME   AGE   LOGGER  LEVEL
 90857  bar   2m48s  root    INFO
 91103  foo     20s  root    INFO

camel cmd logger --level=DEBUG foo

camel get service
 PID   NAME       COMPONENT      PROTOCOL  SERVICE
 1912  netty      netty          tcp       tcp:localhost:4444
 2023  greetings  platform-http  rest      http://0.0.0.0:7777/camel/greetings/{name} (GET)
 2023  greetings  platform-http  http      http://0.0.0.0:7777/q/dev

camel get circuit-breaker
  PID   NAME  COMPONENT     ROUTE   ID               STATE      PENDING  SUCCESS  FAIL  REJECT
 56033  mycb  resilience4j  route1  circuitBreaker1  HALF_OPEN        5        2     3       0

Camel CLI ファイルは、パイプとフィルターを使用したターミナルスクリプトに使用するスクリプトとして実行できます。

これには、たとえば、以下の upper.yaml ファイルのように、ファイルの先頭に次の行を追加する必要があります。

///usr/bin/env jbang --quiet camel@apache/camel pipe "$0" "$@" ; exit $?

# Will upper-case the input
- from:
    uri: "stream:in"
    steps:
      - setBody:
          simple: "${body.toUpperCase()}"
      - to: "stream:out"

これをスクリプトとして実行するには、ファイル実行権限を設定する必要があります。

chmod +x upper.yaml

次に、これをスクリプトとして実行できます。

echo "Hello\nWorld" | ./upper.yaml

これにより次の出力が出力されます。

HELLO
WORLD

--logging=true を使用してログをオンにすると、.camel-jbang/camel-pipe.log ファイルにログが記録されます。ログファイルの名前は設定できません。

echo "Hello\nWorld" | ./upper.yaml --logging=true

Camel CLI を使用すると、GitHub で公開したり、jar にパッケージ化したりすることなく、ローカルの Kamelet を試すことができます。

camel run --local-kamelet-dir=/path/to/local/kamelets earthquake.yaml

GitHub リポジトリー内のフォルダーを指定することもできます。以下に例を示します。

camel run --local-kamelet-dir=https://github.com/apache/camel-kamelets-examples/tree/main/custom-kamelets user.java

ルートが platform-http から開始すると、Camel CLI にはポート 8080 で実行されている VertX HTTP サーバーが自動的に組み込まれます。次の例は、server.yaml という名前のファイル内のルートを示しています。

- from:
    uri: "platform-http:/hello"
    steps:
      - set-body:
          constant: "Hello World"

この例は次のように実行できます。

camel run server.yaml

次に、次のようにして HTTP サービスを呼び出します。

$ curl http://localhost:8080/hello
Hello World%

通常の Java ソースファイルを Camel ルートとともに含める基本サポートがあり、Camel CLI ランタイムに Java ソースをコンパイルさせます。これは、アプリケーションに必要な小さなユーティリティークラス、POJO、Camel プロセッサーを含めることができることを意味します。

利用可能なデバッグには次の 2 種類があります。

jbang --debug  camel@apache/camel run hello.yaml
Listening for transport dt_socket at address: 4004

ヘルスチェックのステータスには、次のように CLI から Camel CLI を使用してアクセスします。

camel get health
  PID   NAME    AGE  ID             RL  STATE  RATE    SINCE   MESSAGE
 61005  mybind   8s  camel/context   R   UP    2/2/-  1s/3s/-

ここでは Camel が UP しているのがわかります。アプリケーションは 8 秒間実行されており、2 つのヘルスチェックが呼び出されています。

出力には、チェックの default レベルが次のように表示されます。

RATE 列には、/ で区切られた 3 つの数字が表示されます。したがって、2/2/- は合計 2 つのチェック、2 つは成功し、失敗はなしということを意味します。最後の 2 つの列は、この数値が成功または失敗した連続チェックの数であるため、ヘルスチェックの状態が変化するとリセットされます。したがって、ヘルスチェックが失敗し始めると、数値は次のようになります。

camel get health
  PID   NAME     AGE   ID             RL  STATE   RATE    SINCE    MESSAGE
 61005  mybind   3m2s  camel/context   R   UP    77/-/3  1s/-/17s  some kind of error

ここでは、数値が 77/-/3 に変更されていることがわかります。つまり、チェックの合計数は 77 になります。成功はありませんが、チェックは 3 回連続で失敗しています。SINCE 列は RATE に対応します。したがって、この場合、最後のチェックは 1 秒前であり、チェックは 17 秒連続で失敗していることがわかります。

--level=full を使用すると、コンシューマーおよびルートレベルのチェックも含むすべてのヘルスチェックを出力できます。

ヘルスチェックは、--trace フラグを使用して表示できる例外が出力されたために失敗することがよくあります。

camel get health --trace
  PID   NAME      AGE   ID                                      RL  STATE    RATE       SINCE     MESSAGE
 61038  mykafka  6m19s  camel/context                            R   UP    187/187/-  1s/6m16s/-
 61038  mykafka  6m19s  camel/kafka-consumer-kafka-not-secure…   R  DOWN   187/-/187  1s/-/6m16s  KafkaConsumer is not ready - Error: Invalid url in bootstrap.servers: value


------------------------------------------------------------------------------------------------------------------------
                                                       STACK-TRACE
------------------------------------------------------------------------------------------------------------------------
    PID: 61038
    NAME: mykafka
    AGE: 6m19s
    CHECK-ID: camel/kafka-consumer-kafka-not-secured-source-1
    STATE: DOWN
    RATE: 187
    SINCE: 6m16s
    METADATA:
        bootstrap.servers = value
        group.id = 7d8117be-41b4-4c81-b4df-cf26b928d38a
        route.id = kafka-not-secured-source-1
        topic = value
    MESSAGE: KafkaConsumer is not ready - Error: Invalid url in bootstrap.servers: value
    org.apache.kafka.common.KafkaException: Failed to construct kafka consumer
        at org.apache.kafka.clients.consumer.KafkaConsumer.<init>(KafkaConsumer.java:823)
        at org.apache.kafka.clients.consumer.KafkaConsumer.<init>(KafkaConsumer.java:664)
        at org.apache.kafka.clients.consumer.KafkaConsumer.<init>(KafkaConsumer.java:645)
        at org.apache.kafka.clients.consumer.KafkaConsumer.<init>(KafkaConsumer.java:625)
        at org.apache.camel.component.kafka.DefaultKafkaClientFactory.getConsumer(DefaultKafkaClientFactory.java:34)
        at org.apache.camel.component.kafka.KafkaFetchRecords.createConsumer(KafkaFetchRecords.java:241)
        at org.apache.camel.component.kafka.KafkaFetchRecords.createConsumerTask(KafkaFetchRecords.java:201)
        at org.apache.camel.support.task.ForegroundTask.run(ForegroundTask.java:123)
        at org.apache.camel.component.kafka.KafkaFetchRecords.run(KafkaFetchRecords.java:125)
        at java.base/java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:515)
        at java.base/java.util.concurrent.FutureTask.run(FutureTask.java:264)
        at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1128)
        at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:628)
        at java.base/java.lang.Thread.run(Thread.java:829)
    Caused by: org.apache.kafka.common.config.ConfigException: Invalid url in bootstrap.servers: value
        at org.apache.kafka.clients.ClientUtils.parseAndValidateAddresses(ClientUtils.java:59)
        at org.apache.kafka.clients.ClientUtils.parseAndValidateAddresses(ClientUtils.java:48)
        at org.apache.kafka.clients.consumer.KafkaConsumer.<init>(KafkaConsumer.java:730)
        ... 13 more

ここでは、無効な設定 (Invalid url in bootstrap.servers: value) による org.apache.kafka.common.config.ConfigException が原因でヘルスチェックが失敗していることがわかります。

doc のゴールでは、すべてのコンポーネント、データ形式、Kamelet の簡単なドキュメントを表示できます。たとえば、kafka コンポーネントを確認するには、次を実行します。

camel doc kafka

jackson データ形式のドキュメントを参照するには:

camel doc jackson

まれに、同じ名前のコンポーネントとデータ形式が存在し、doc の目標によってコンポーネントが優先されることがあります。このような状況では、次のように名前の前にデータ形式を付けることができます。

camel doc dataformat:thrift

次のような kamelet ドキュメントも参照できます。

camel doc aws-kinesis-sink

camel doc kafka --open-url

camel doc aws-kinesis-sink --open-url

camel doc kafka --filter=security

camel doc kafka --filter=timeout

コマンド export --runtime=quarkus は、現在の Camel CLI ファイルを、src/main/ フォルダー構造で編成されたファイルとともに Maven ベースのプロジェクトにエクスポートします。

たとえば、quarkus ランタイム、maven groupID com.foo、artifactId acme、およびバージョン 1.0-SNAPSHOT を使用して、camel-quarkus-jbang ディレクトリーにエクスポートするには、次を実行します。

camel export --runtime=quarkus --gav=com.foo:acme:1.0-SNAPSHOT --quarkus-group-id=com.redhat.quarkus.platform --quarkus-version=3.15.3.redhat-00002 --dep=org.apache.camel.quarkus:camel-quarkus-timer,org.apache.camel.quarkus:camel-quarkus-management,org.apache.camel.quarkus:camel-quarkus-cli-connector --repos=https://maven.repository.redhat.com/ga,https://packages.atlassian.com/maven-external --directory=camel-quarkus-jbang

camel export --runtime=quarkus --gav=com.foo:acme:1.0-SNAPSHOT --directory=../myproject

エクスポートする場合、pom.xml または build.gradle で定義された Camel バージョンは、Camel CLI が使用するバージョンと同じです。ただし、次のように別の Camel バージョンを指定できます。

camel export --runtime=quarkus --gav=com.foo:acme:1.0-SNAPSHOT --directory=../myproject --quarkus-version=3.15.3.redhat-00002

Quarkus または Camel Main にエクスポートする場合、Camel JBang CLI はそのままでは含まれません。Camel CLI (Camel) を引き続き使用するには、次のように --dep オプションに Camel:cli-connector を追加する必要があります。

camel export --runtime=quarkus --gav=com.foo:acme:1.0-SNAPSHOT --dep=camel:cli-connector --directory=../myproject

デフォルトでは、export コマンドは application.properties ファイルから設定をロードします。このファイルは、ランタイムや Java バージョンの選択などの特定のパラメーターをエクスポートするために使用されます。

exporting に関連する次のオプションは、application.properties ファイルで設定できます。

Camel CLI の config コマンドは、ユーザー設定を保存および使用するために使用されます。これにより、毎回 CLI オプションを指定する必要がなくなります。たとえば、別の Camel バージョンを実行するには、次を使用します。

camel run * --camel-version=4.8

camel-version は次のようなユーザー設定に追加できます。

camel config set camel-version=4.8

run コマンドはユーザー設定を使用します。

camel run *

ユーザー設定ファイルは ~/.camel-jbang-user.properties に保存されます。

camel config set gav=com.foo:acme:1.0-SNAPSHOT
camel config set runtime=quarkus
camel config set deps=org.apache.camel.quarkus:camel-timer,camel:management,camel:cli-connector
camel config set camel-version=4.8
camel config set camel-quarkus-version=3.15

camel export

camel init foo.yaml

camel run foo.yaml --https://maven.repository.redhat.com/ga,https://packages.atlassian.com/maven-external

camel config unset camel-quarkus-version

camel config list

runtime = quarkus
deps = org.apache.camel.springboot:camel-timer-starter
gav = com.foo:acme:1.0-SNAPSHOT

camel config get gav

com.foo:acme:1.0-SNAPSHOT

camel config set repos=https://maven.repository.redhat.com/ga

camel run 'Test.java' --logging-level=info --repos=#repos,https://packages.atlassian.com/maven-external

Camel CLI の config コマンドは、ユーザー設定を保存および使用するために使用します。これにより、毎回 CLI オプションを指定する必要がなくなります。たとえば、別の Camel バージョンを実行するには、次を使用します。

camel run * --camel-version=4.8.3.redhat-00004

camel-version は次のようなユーザー設定に追加できます。

camel config set camel-version=4.8.3.redhat-00004

これは、camel run コマンドの使用時に使用される Camel バージョンを設定します。以下の run コマンドはユーザー設定を使用します。

camel run *

ユーザー設定ファイルは ~/.camel-jbang-user.properties に保存されます。

Camel CLI は、すぐに bash および zsh のシェル補完を提供します。Camel CLI のシェル補完を有効にするには、次を実行します。

source <(camel completion)

これを永続的にするには、次を実行します。

echo 'source <(camel completion)' >> ~/.bashrc

たとえば、2 つの YAML ファイルを実行するなど、複数のファイルからルートを実行できます。

camel run --camel-version=4.8.3.redhat-00004 one.yaml two.yaml

yaml と Java などの 2 つの異なるファイルからルートを実行できます。

camel run --camel-version=4.8.3.redhat-00004 one.yaml hello.java

ワイルドカード (つまり *) を使用して、すべての yaml ファイルを実行するなど、複数のファイルに一致させることができます。

camel run --camel-version=4.8.3.redhat-00004 *.yaml

foo* で始まるすべてのファイルを実行できます。

camel run --camel-version=4.8.3.redhat-00004 foo*

ディレクトリー内のすべてのファイルを実行するには、次を使用します。

camel run --camel-version=4.8.3.redhat-00004 *

非常に小さな Java ルートの場合、以下に示すように、ルートを CLI 引数として指定できます。

camel run --code='from("kamelet:beer-source").to("log:beer")'

CLI 引数はファイルよりも使用が少し面倒であるため、これは非常に制限されています。入力パラメーターからルートを実行する場合は、以下の点に留意してください。

次に示すように --dev オプションを使用して、ソースファイルの更新 (保存) 時にルートのライブリロードに伴う開発モードを有効にできます。

camel run foo.yaml --dev

Camel インテグレーションの実行中に、YAML ルートを更新し、保存時に更新できます。このオプションは、java を含むすべての DLS で機能します。次に例を示します。

camel run hello.java --dev

開発者にさまざまな情報を表示する開発者コンソールを有効にすることができます。開発者コンソールを有効にするには、次を実行します。

camel run hello.java --console

これにより、Web ブラウザーから http://localhost:8080/q/dev (デフォルト) にあるコンソールにアクセスできるようになります。このリンクは、Camel の起動時にログにも表示されます。

コンソールでは、メッセージの処理に最も時間がかかる上位ルートのレポートなど、実行中の Camel インテグレーションに関する洞察を得ることができます。その後、これらのルート内で最も時間がかかっている EIP を個別に特定できます。

開発者コンソールはデータを JSON 形式で出力することもでき、サードパーティーのツールで情報を取得するために使用できます。たとえば、curl 経由で上位のルートを出力するには、次を実行します。

curl -s -H "Accept: application/json"  http://0.0.0.0:8080/q/dev/top/

JSON データをカラーでフォーマットして出力できる jq がインストールされている場合は、次を実行します。

curl -s -H "Accept: application/json"  http://0.0.0.0:8080/q/dev/top/ | jq

Camel CLI の profile は Camel CLI で自動的にロードされる設定を参照する名前 (ID) です。デフォルトのプロファイルは、application という名前が付けられ、これは (スマートデフォルト) で Camel CLI が application.properties (存在する場合) を自動的にロードできるようにします。これは、同じ名前の特定のプロパティーファイルに一致するプロファイルを作成できることを意味します。

たとえば、local という名前のプロファイルを使用して実行すると、Camel CLI は application.properties の代わりに local.properties をロードします。プロファイルを使用するには、次のようにコマンドラインオプション --profile を指定します。

camel run hello.java --profile=local

一度に指定できるプロファイル名は 1 つだけです。たとえば、--profile=local,two は無効です。

properties ファイルでは、Camel Main のすべての設定を行えます。ログマスキングをオフにして有効にするには、次のコマンドを実行します。

camel.main.streamCaching=false
camel.main.logMask=true

また、camel-kafka などの Camel コンポーネントを設定して、URL をブローカーに宣言することもできます。

camel.component.kafka.brokers=broker1:9092,broker2:9092,broker3:9092

デフォルトでは、Camel CLI は Camel の実行に必要な依存関係を自動的に解決します。これは、JBang と Camel によってそれぞれ実行されます。Camel 自体は、クラスパス上で現在利用できない JAR がコンポーネントに必要かどうかを実行時に検出し、JAR を自動的にダウンロードできます。

Camel はこれらの JAR を次の順序でダウンロードします。

Camel CLI をインターネット経由でダウンロードしない場合は、次のように --download オプションを使用してこれをオフにできます。

camel run foo.java --download=false

Camel CLI は、独自のリリースからの Camel コンポーネント、言語、データ形式の依存関係を自動的に検出します。これは、使用する JAR を指定する必要がないことを意味します。ただし、サードパーティーのカスタム JAR を追加する必要がある場合は、次のように、Maven GAV 構文 (groupId:artifactId:version) の CLI 引数として --dep を使用してこれらを指定できます。

camel run foo.java --dep=com.foo:acme:1.0

To add a Camel dependency explicitly you can use a shorthand syntax (starting with `camel:` or `camel-`):

camel run foo.java --dep=camel-saxon

複数の依存関係をコンマで区切って指定できます。

camel run foo.java --dep=camel-saxon,com.foo:acme:1.0

Camel CLI は、まずローカルリポジトリーからダウンロードし、次にオンラインの Maven Central リポジトリーからダウンロードします。サードパーティーの Maven リポジトリーからダウンロードするには、これを CLI 引数として、または application.properties ファイルで指定する必要があります。

camel run foo.java --repos=https://packages.atlassian.com/maven-external

サードパーティーの Maven リポジトリーの設定は、次に示すように、camel.jbang.repos キーを使用して application.properties ファイルで設定されます。

camel.jbang.repos=https://packages.atlassian.com/maven-external

Camel ルートを実行すると、application.properties が自動的に読み込まれます。

camel run foo.java

使用するプロパティーファイルを明示的に指定することもできます。

camel run foo.java application.properties

または、これをプロファイルとして指定することもできます。

camel run foo.java --profile=application

ここで、プロファイル ID はプロパティーファイルの名前です。

デフォルトでは、既存の ~/.m2/settings.xml ファイルがロードされるため、Maven 解決プロセスの動作を変更することができます。Maven 設定ファイルは、Maven ミラー、認証情報設定 (暗号化される可能性がある)、またはアクティブなプロファイル、および追加のリポジトリーに関する情報を提供します。

Maven リポジトリーは認証を使用でき、Maven で認証情報を設定するには <server> 要素を使用します。

<server>
    <id>external-repository</id>
    <username>camel</username>
    <password>{SSVqy/PexxQHvubrWhdguYuG7HnTvHlaNr6g3dJn7nk=}</password>
</server>

パスワードはプレーンテキストを使用して指定できますが、最初に Maven マスターパスワードを設定してから、それを使用してリポジトリーパスワードを設定することを推奨します。

$ mvn -emp
Master password: camel
{hqXUuec2RowH8dA8vdqkF6jn4NU9ybOsDjuTmWvYj4U=}

上記のパスワードは、次のように ~/.m2/settings-security.xml ファイルに追加する必要があります。

<settingsSecurity>
  <master>{hqXUuec2RowH8dA8vdqkF6jn4NU9ybOsDjuTmWvYj4U=}</master>
</settingsSecurity>

その後、通常のパスワードを設定できます。

$ mvn -ep
Password: camel
{SSVqy/PexxQHvubrWhdguYuG7HnTvHlaNr6g3dJn7nk=}

その後、このパスワードを <server>/<password> 設定で使用できます。

デフォルトでは、Maven は ~/.m2/settings-security.xml ファイルからマスターパスワードを読み取りますが、これをオーバーライドすることもできます。settings.xml ファイル自体の場所は、次のように指定できます。

camel run foo.java --maven-settings=/path/to/settings.xml --maven-settings-security=/path/to/settings-security.xml

場所 (~/.m2/settings.xml であっても) を想定せずに Camel アプリケーションを実行したい場合は、このオプションを使用します。

camel run foo.java --maven-settings=false

Camels リソースローダーを使用して、GitHub でホストされているルートを実行できます。たとえば、Camel K サンプルの 1 つを実行するには、次を使用します。

camel run github:apache:camel-kamelets-examples:jbang/hello-java/Hey.java

GitHub の https URL を使用することもできます。たとえば、Web ブラウザーからサンプルを参照し、ブラウザーウィンドウから URL をコピーして、Camel CLI でサンプルを実行できます。

camel run https://github.com/apache/camel-kamelets-examples/tree/main/jbang/hello-java

すべての groovy ファイルを実行するなど、ワイルドカード (つまり \*) を使用して複数のファイルと一致させることもできます。

camel run https://github.com/apache/camel-kamelets-examples/tree/main/jbang/languages/*.groovy

または、rou* で始まるすべてのファイルを実行することもできます。

camel run https://github.com/apache/camel-kamelets-examples/tree/main/jbang/languages/rou*

camel run https://gist.github.com/davsclaus/477ddff5cdeb1ae03619aa544ce47e92

Camel CLI を使用すると、既存のサンプルを GitHub からローカルディスクにダウンロードできます。これにより、サンプルを変更してローカルで実行できるようになります。たとえば、次のコマンドを実行して dependency injection 例をダウンロードできます。

camel init https://github.com/apache/camel-kamelets-examples/tree/main/jbang/dependency-injection

次に、ファイル (サブフォルダーではなく) が現在のディレクトリーにダウンロードされます。次に、次のようにしてサンプルをローカルで実行できます。

camel run *

--directory オプションを使用してファイルを新しいフォルダーにダウンロードすることもできます。たとえば、ファイルを myproject という名前のフォルダーにダウンロードするには、次のコマンドを実行します。

camel init https://github.com/apache/camel-kamelets-examples/tree/main/jbang/dependency-injection --directory=myproject

この例を開発モードで実行して、ソースコードの変更をホットデプロイすることができます。

camel run * --dev

単一のファイルをダウンロードできます。たとえば、Camel K サンプルの 1 つをダウンロードするには、次を実行します。

camel init https://github.com/apache/camel-k-examples/blob/main/generic-examples/languages/simple.groovy

これは素晴らしいルートで、次のように実行できます (または * を使用します)。

camel run simple.groovy

camel init https://gist.github.com/davsclaus/477ddff5cdeb1ae03619aa544ce47e92

camel run *

camel init https://gist.github.com/davsclaus/477ddff5cdeb1ae03619aa544ce47e92 --directory=foobar

Camel は、CRD 形式 (Kubernetes カスタムリソース定義) の Camel K インテグレーションとバインディングファイルの実行をサポートしています。たとえば、joke.yaml という名前の kamelet バインディングファイルを実行するには、次のようにします。

#!/usr/bin/env jbang camel@apache/camel run
apiVersion: camel.apache.org/v1alpha1
kind: KameletBinding
metadata:
  name: joke
spec:
  source:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: chuck-norris-source
    properties:
      period: 2000
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: log-sink
    properties:
      show-headers: false

camel run joke.yaml

Camel ルートは OS クリップボードから直接実行できます。これにより、コードをコピーして、ルートをすぐに実行できます。

camel run clipboard.<extension>

ここで、<extension> は、クリップボードのコンテンツのタイプ (java、xml、yaml など) です。

たとえば、これをクリップボードにコピーして、ルートを実行できます。

<route>
  <from uri="timer:foo"/>
  <log message="Hello World"/>
</route>

camel run clipboard.xml

現在実行中の Camel インテグレーションをリスト表示するには、ps オプションを使用します。

camel ps
  PID   NAME                          READY  STATUS    AGE
 61818  sample.camel.MyCamelApplica…   1/1   Running  26m38s
 62506  test1                          1/1   Running   4m34s

これには、PID、インテグレーションの名前、経過時間がリストされます。

stop コマンドを使用すると、これらの実行中の Camel インテグレーションを停止できます。たとえば、test1 を停止するには、次を実行します。

camel stop test1
Stopping running Camel integration (pid: 62506)

PID を使用してインテグレーションを停止できます。

camel stop 62506
Stopping running Camel integration (pid: 62506)

すべてのインテグレーションを停止するには、次のように --all オプションを使用します。

camel stop --all
Stopping running Camel integration (pid: 61818)
Stopping running Camel integration (pid: 62506)

Camel CLI は、デフォルトでは、CLI を使用して実行されている Camel インテグレーション (camel run foo.java など) のみを制御します。

CLI が Spring Boot または Quarkus アプリケーションを制御および管理できるようにするには、これらのプロジェクトに依存関係を追加して Camel CLI とインテグレーションする必要があります。

<dependency>
    <groupId>org.apache.camel.springboot</groupId>
    <artifactId>camel-cli-connector-starter</artifactId>
</dependency>

<dependency>
    <groupId>org.apache.camel.quarkus</groupId>
    <artifactId>camel-quarkus-cli-connector</artifactId>
</dependency>

Camel CLI の get コマンドは、稼働中の Camel インテグレーションの 1 つまたはすべてに関する Camel 固有のステータスを取得するために使用されます。実行中の Camel インテグレーションの状態を表示するには、以下を実行します。

camel get
  PID   NAME      CAMEL            PLATFORM            READY  STATUS    AGE    TOTAL  FAILED  INFLIGHT  SINCE-LAST
 61818  MyCamel   4.8.0-SNAPSHOT  Spring Boot v2.7.3   1/1   Running  28m34s    854       0         0     0s/0s/-
 63051  test1     4.8.0-SNAPSHOT  JBang                1/1   Running     18s     14       0         0     0s/0s/-
 63068  mygroovy  4.8.0-SNAPSHOT  JBang                1/1   Running      5s      2       0         0     0s/0s/-

camel get コマンドは、デフォルトのインテグレーションを表示します。これは、camel get integrations コマンドまたは camel get int コマンドの入力と同じです。

これにより、すべての Camel インテグレーションに関する全体的な情報が表示されます。ここでは、処理されたメッセージの合計数を確認できます。列 Since Last は、3 つのステージ (started/completed/failed) の最後の処理済みメッセージの前に時間を示します。

0s/ 0s/- の値は、最後に開始および完了したメッセージが発生したこと (0 秒前)、および失敗したメッセージがまだないことを意味します。この例では、9s/9s/1h3m は、最後に開始および完了したメッセージが 9 秒前に、最後の失敗は 1 時間、3 分前であることを意味します。

camel get route を使用したすべてのローカル Camel インテグレーションから、すべてのルートのステータスを確認することもできます。

camel get route
  PID   NAME      ID      FROM                        STATUS    AGE   TOTAL  FAILED  INFLIGHT  MEAN  MIN  MAX  SINCE-LAST
 61818  MyCamel   hello   timer://hello?period=2000   Running  29m2s    870       0         0     0    0   14     0s/0s/-
 63051  test1      java    timer://java?period=1000    Running    46s     46       0         0     0    0    9     0s/0s/-
 63068  mygroovy  groovy  timer://groovy?period=1000  Running    34s     34       0         0     0    0    5     0s/0s/-

camel top
  PID   NAME     JAVA     CAMEL            PLATFORM            STATUS    AGE         HEAP        NON-HEAP     GC     THREADS   CLASSES
 22104  chuck    11.0.13  4.8.0-SNAPSHOT  JBang               Running   2m10s  131/322/4294 MB  70/73 MB  17ms (6)      7/8  7456/7456
 14242  MyCamel  11.0.13  4.8.0-SNAPSHOT  Spring Boot v2.7.3  Running  33m40s  115/332/4294 MB  62/66 MB  37ms (6)    16/16  8428/8428
 22116  bar      11.0.13  4.8.0-SNAPSHOT  JBang               Running    2m7s   33/268/4294 MB  54/58 MB  20ms (4)      7/8  6104/6104

camel top route
  PID   NAME     ID                     FROM                                 STATUS    AGE    TOTAL  FAILED  INFLIGHT  MEAN  MIN  MAX  SINCE-LAST
 22104  chuck    chuck-norris-source-1  timer://chuck?period=10000           Started     10s      1       0         0   163  163  163          9s
 22116  bar      route1                 timer://yaml2?period=1000            Started      7s      7       0         0     1    0   11          0s
 22104  chuck    chuck                  kamelet://chuck-norris-source        Started     10s      1       0         0     0    0    0          9s
 22104  chuck    log-sink-2             kamelet://source?routeId=log-sink-2  Started     10s      1       0         0     0    0    0          9s
 14242  MyCamel  hello                  timer://hello?period=2000            Started  31m41s    948       0         0     0    0    4          0s

camel cmd stop-route chuck

camel get route
  PID   NAME     ID                     FROM                                 STATUS    AGE   TOTAL  FAILED  INFLIGHT  MEAN  MIN  MAX  SINCE-LAST
 81663  chuck    chuck                  kamelet://chuck-norris-source        Stopped           600       0         0     0    0    1          4s
 81663  chuck    chuck-norris-source-1  timer://chuck?period=10000           Stopped           600       0         0    65   52  290          4s
 81663  chuck    log-sink-2             kamelet://source?routeId=log-sink-2  Stopped           600       0         0     0    0    1          4s
 83415  bar      route1                 timer://yaml2?period=1000            Started  5m30s    329       0         0     0    0   10          0s
 83695  MyCamel  hello                  timer://hello?period=2000            Started  3m52s    116       0         0     0    0    9          1s

camel cmd start-route chuck

camel cmd stop-route --all

camel cmd start-route --all

camel cmd logger
  PID   NAME   AGE   LOGGER  LEVEL
 90857  bar   2m48s  root    INFO
 91103  foo     20s  root    INFO

camel cmd logger --level=DEBUG foo

camel get service
 PID   NAME       COMPONENT      PROTOCOL  SERVICE
 1912  netty      netty          tcp       tcp:localhost:4444
 2023  greetings  platform-http  rest      http://0.0.0.0:7777/camel/greetings/{name} (GET)
 2023  greetings  platform-http  http      http://0.0.0.0:7777/q/dev

camel get circuit-breaker
  PID   NAME  COMPONENT     ROUTE   ID               STATE      PENDING  SUCCESS  FAIL  REJECT
 56033  mycb  resilience4j  route1  circuitBreaker1  HALF_OPEN        5        2     3       0

Camel CLI ファイルは、パイプとフィルターを使用したターミナルスクリプトに使用するスクリプトとして実行できます。

これには、たとえば、以下の upper.yaml ファイルのように、ファイルの先頭に次の行を追加する必要があります。

///usr/bin/env jbang --quiet camel@apache/camel pipe "$0" "$@" ; exit $?

# Will upper-case the input
- from:
    uri: "stream:in"
    steps:
      - setBody:
          simple: "${body.toUpperCase()}"
      - to: "stream:out"

これをスクリプトとして実行するには、ファイル実行権限を設定する必要があります。

chmod +x upper.yaml

次に、これをスクリプトとして実行できます。

echo "Hello\nWorld" | ./upper.yaml

これにより次の出力が出力されます。

HELLO
WORLD

--logging=true を使用してログをオンにすると、.camel-jbang/camel-pipe.log ファイルにログが記録されます。ログファイルの名前は設定できません。

echo "Hello\nWorld" | ./upper.yaml --logging=true

Camel CLI を使用すると、GitHub で公開したり、jar にパッケージ化したりすることなく、ローカルの Kamelet を試すことができます。

camel run --local-kamelet-dir=/path/to/local/kamelets earthquake.yaml

GitHub リポジトリー内のフォルダーを指定することもできます。以下に例を示します。

camel run --local-kamelet-dir=https://github.com/apache/camel-kamelets-examples/tree/main/custom-kamelets user.java

ルートが platform-http から開始すると、Camel CLI にはポート 8080 で実行されている VertX HTTP サーバーが自動的に組み込まれます。次の例は、server.yaml という名前のファイル内のルートを示しています。

- from:
    uri: "platform-http:/hello"
    steps:
      - set-body:
          constant: "Hello World"

この例は次のように実行できます。

camel run server.yaml

次に、次のようにして HTTP サービスを呼び出します。

$ curl http://localhost:8080/hello
Hello World%

通常の Java ソースファイルを Camel ルートとともに含める基本サポートがあり、Camel CLI ランタイムに Java ソースをコンパイルさせます。これは、アプリケーションに必要な小さなユーティリティークラス、POJO、Camel プロセッサーを含めることができることを意味します。

Camel-jbang を使用して Camel 統合を実行する場合、ランタイムは Camel-main ベースになります。これは、Spring Boot または Quarkus が利用できないことを意味します。ただし、Java クラスでのアノテーションベースの依存関係注入の使用はサポートされています。

利用可能なデバッグには次の 2 種類があります。

jbang --debug  camel@apache/camel run hello.yaml
Listening for transport dt_socket at address: 4004

ヘルスチェックのステータスには、次のように CLI から Camel CLI を使用してアクセスします。

camel get health
  PID   NAME    AGE  ID             RL  STATE  RATE    SINCE   MESSAGE
 61005  mybind   8s  camel/context   R   UP    2/2/-  1s/3s/-

ここでは Camel が UP しているのがわかります。アプリケーションは 8 秒間実行されており、2 つのヘルスチェックが呼び出されています。

出力には、チェックの default レベルが次のように表示されます。

RATE 列には、/ で区切られた 3 つの数字が表示されます。したがって、2/2/- は合計 2 つのチェック、2 つは成功し、失敗はなしということを意味します。最後の 2 つの列は、この数値が成功または失敗した連続チェックの数であるため、ヘルスチェックの状態が変化するとリセットされます。したがって、ヘルスチェックが失敗し始めると、数値は次のようになります。

camel get health
  PID   NAME     AGE   ID             RL  STATE   RATE    SINCE    MESSAGE
 61005  mybind   3m2s  camel/context   R   UP    77/-/3  1s/-/17s  some kind of error

ここでは、数値が 77/-/3 に変更されていることがわかります。つまり、チェックの合計数は 77 になります。成功はありませんが、チェックは 3 回連続で失敗しています。SINCE 列は RATE に対応します。したがって、この場合、最後のチェックは 1 秒前であり、チェックは 17 秒連続で失敗していることがわかります。

--level=full を使用すると、コンシューマーおよびルートレベルのチェックも含むすべてのヘルスチェックを出力できます。

ヘルスチェックは、--trace フラグを使用して表示できる例外が出力されたために失敗することがよくあります。

camel get health --trace
  PID   NAME      AGE   ID                                      RL  STATE    RATE       SINCE     MESSAGE
 61038  mykafka  6m19s  camel/context                            R   UP    187/187/-  1s/6m16s/-
 61038  mykafka  6m19s  camel/kafka-consumer-kafka-not-secure…   R  DOWN   187/-/187  1s/-/6m16s  KafkaConsumer is not ready - Error: Invalid url in bootstrap.servers: value


------------------------------------------------------------------------------------------------------------------------
                                                       STACK-TRACE
------------------------------------------------------------------------------------------------------------------------
    PID: 61038
    NAME: mykafka
    AGE: 6m19s
    CHECK-ID: camel/kafka-consumer-kafka-not-secured-source-1
    STATE: DOWN
    RATE: 187
    SINCE: 6m16s
    METADATA:
        bootstrap.servers = value
        group.id = 7d8117be-41b4-4c81-b4df-cf26b928d38a
        route.id = kafka-not-secured-source-1
        topic = value
    MESSAGE: KafkaConsumer is not ready - Error: Invalid url in bootstrap.servers: value
    org.apache.kafka.common.KafkaException: Failed to construct kafka consumer
        at org.apache.kafka.clients.consumer.KafkaConsumer.<init>(KafkaConsumer.java:823)
        at org.apache.kafka.clients.consumer.KafkaConsumer.<init>(KafkaConsumer.java:664)
        at org.apache.kafka.clients.consumer.KafkaConsumer.<init>(KafkaConsumer.java:645)
        at org.apache.kafka.clients.consumer.KafkaConsumer.<init>(KafkaConsumer.java:625)
        at org.apache.camel.component.kafka.DefaultKafkaClientFactory.getConsumer(DefaultKafkaClientFactory.java:34)
        at org.apache.camel.component.kafka.KafkaFetchRecords.createConsumer(KafkaFetchRecords.java:241)
        at org.apache.camel.component.kafka.KafkaFetchRecords.createConsumerTask(KafkaFetchRecords.java:201)
        at org.apache.camel.support.task.ForegroundTask.run(ForegroundTask.java:123)
        at org.apache.camel.component.kafka.KafkaFetchRecords.run(KafkaFetchRecords.java:125)
        at java.base/java.util.concurrent.Executors$RunnableAdapter.call(Executors.java:515)
        at java.base/java.util.concurrent.FutureTask.run(FutureTask.java:264)
        at java.base/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1128)
        at java.base/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:628)
        at java.base/java.lang.Thread.run(Thread.java:829)
    Caused by: org.apache.kafka.common.config.ConfigException: Invalid url in bootstrap.servers: value
        at org.apache.kafka.clients.ClientUtils.parseAndValidateAddresses(ClientUtils.java:59)
        at org.apache.kafka.clients.ClientUtils.parseAndValidateAddresses(ClientUtils.java:48)
        at org.apache.kafka.clients.consumer.KafkaConsumer.<init>(KafkaConsumer.java:730)
        ... 13 more

ここでは、無効な設定 (Invalid url in bootstrap.servers: value) による org.apache.kafka.common.config.ConfigException が原因でヘルスチェックが失敗していることがわかります。

doc のゴールでは、すべてのコンポーネント、データ形式、Kamelet の簡単なドキュメントを表示できます。たとえば、kafka コンポーネントを確認するには、次を実行します。

camel doc kafka

jackson データ形式のドキュメントを参照するには:

camel doc jackson

まれに、同じ名前のコンポーネントとデータ形式が存在し、doc の目標によってコンポーネントが優先されることがあります。このような状況では、次のように名前の前にデータ形式を付けることができます。

camel doc dataformat:thrift

次のような kamelet ドキュメントも参照できます。

camel doc aws-kinesis-sink

camel doc kafka --open-url

camel doc aws-kinesis-sink --open-url

camel doc kafka --filter=security

camel doc kafka --filter=timeout

コマンド export --runtime=spring-boot は、現在の Camel CLI ファイルを、src/main/ フォルダー構造で編成されたファイルとともに Maven ベースの Spring Boot プロジェクトにエクスポートします。

たとえば、Maven の groupId com.foo と artifactId acme を使用し、バージョン 1.0-SNAPSHOT を使用して Spring Boot にエクスポートするには、次のコマンドを実行します。

camel export --runtime=spring-boot --gav=com.foo:acme:1.0-SNAPSHOT

camel export --runtime=spring-boot --gav=com.foo:acme:1.0-SNAPSHOT --directory=../myproject

camel export --runtime=spring-boot --gav=com.foo:acme:1.0-SNAPSHOT --directory=../myproject --camel-spring-boot-version=4.8.3.redhat-00009

詳細は、camel export --help コマンドを実行して、使用可能なオプションを確認してください。

Spring Boot、Quarkus、または Camel Main にエクスポートする場合、Camel JBang CLI はそのままでは含まれません。Camel CLI (Camel) を引き続き使用するには、次のように --dep オプションに Camel:cli-connector を追加する必要があります。

camel export --runtime=spring-boot --gav=com.foo:acme:1.0-SNAPSHOT --dep=camel:cli-connector --directory=../myproject

デフォルトでは、export コマンドは application.properties ファイルから設定をロードします。このファイルは、ランタイムや Java バージョンの選択などの特定のパラメーターをエクスポートするために使用されます。

exporting に関連する次のオプションは、application.properties ファイルで設定できます。

Camel CLI の config コマンドは、ユーザー設定を保存および使用するために使用します。これにより、毎回 CLI オプションを指定する必要がなくなります。たとえば、別の Camel バージョンを実行するには、次を使用します。

camel run * --camel-version=4.8

camel-version は次のようなユーザー設定に追加できます。

camel config set camel-version=4.8

run コマンドはユーザー設定を使用します。

camel run *

ユーザー設定ファイルは ~/.camel-jbang-user.properties に保存されます。

camel init foo.yaml
camel config set gav=com.foo:acme:1.0-SNAPSHOT
camel config set runtime=spring-boot
camel config set deps=org.apache.camel.springboot:camel-timer-starter
camel config set camel-spring-boot-version=4.8.3.redhat-00009
camel config set additional-properties=openshift-maven-plugin-version=1.17.0.redhat-00022

camel export

camel config unset camel-spring-boot-version

camel config list

runtime = spring-boot
deps = org.apache.camel.springboot:camel-timer-starter
gav = com.foo:acme:1.0-SNAPSHOT

camel config get gav

com.foo:acme:1.0-SNAPSHOT

camel config set repos=https://maven.repository.redhat.com/ga

camel run 'Test.java' --logging-level=info --repos=#repos,https://packages.atlassian.com/maven-external

JBang を使用すると、状態が ~/.jbang ディレクトリーに保存されます。これは、JBang がダウンロードした JAR を保存する場所でもあります。Camel CLI は、実行中に必要な依存関係もダウンロードします。ただし、これらの依存関係はローカルの Maven リポジトリー ~/.m2 にダウンロードされます。そのため、Camel CLI の実行中に古い JAR などの問題をトラブルシューティングする場合は、これらのディレクトリーまたはその一部を削除してみてください。