1 of 10

Admin

Alerts

This page describes the commands to manage Lenses Alerts via the CLI.

View all raised alert notifications

Copy

lenses-cli alerts

View all alert settings

Copy

lenses-cli alert settings

View an alert setting

lenses-cli alert setting --id=2000

Enable or disable an alert setting

Enabling

lenses-cli alert setting --id=1000 --enable

Disabling

lenses-cli alert setting --id=1000 --enable=false

View all conditions that belong to a specific alert setting

lenses-cli alert setting conditions --alert=2000

Create or update an existing condition for a specific alert setting

lenses-cli alert setting condition set \
--alert=2000 \
--condition="lag >= 200000 on group groupA and topic topicA" \
--channels="f9d6140c-4823-4157-a93c-5147aa0e2f29"

# For "Data Produced" type of alert rules
lenses-cli alert setting condition set \
    --alert=5000 \
    --topic=my-topic \
    --duration=PT6H \
    --more-than=5

# optional channels can be used more than once
# You can get the ID of a channel with `lenses-cli alertchannels`
lenses-cli alert setting condition set \
    --alert=5000 \
    --topic=my-topic \
    --duration=PT6H \
    --more-than=5 \
    --channels="9176c428-be0e-4c36-aa1e-8b8a66782232" \
    --channels="7b184b13-f37c-4eee-9c0a-17dec2fd7bf5"

Update an existing condition using flags

lenses-cli alert setting condition set --alert 2000 \
    --condition="lag >= 95 on group group-1 and topic topic-1" \
    --conditionID="5a6c3951-dfde-478e-8952-8193e62a9a8a" \
    --channels="143315dd-80bf-4833-a13a-394be06dda87" \
    --channels="f9d6140c-4823-4157-a93c-5147aa0e2f29"

# For "Data Produced" type of alert rules
# update - identify rule to update by its condition ID
lenses-cli alert settings --query="categories.producers" | jq .

lenses-cli alert setting condition set \
    --conditionID=f4a623e3-5287-4ca3-9d05-8f0ab68a9b4b \
    --alert=5000 \
    --topic=my-topic \
    --duration=PT6H \
    --more-than=5

Create or update a condition from a file

cat > alert_cond.yaml <<- "EOF"
alert: 2000
conditionID: "5a6c3951-dfde-478e-8952-8193e62a9a8a"
condition:
  "lag >= 30 on group schema-registry and topic backblaze_smart"
channels:
  - "143315dd-80bf-4833-a13a-394be06dda87"
  - "f9d6140c-4823-4157-a93c-5147aa0e2f29"
EOF

lenses-cli alert setting condition set alert_cond.yaml

# For "Data Produced" type of alert rules
cat > data_produced_alert.yaml <<- "EOF"
topic: "my-yaml-topic"
alert: 5000
more-than: 6990
duration: "PT6H"
EOF

lenses-cli alert setting condition set data_produced_alert.yml

Command line flags are ignored when loading from files.

Delete an existing condition for a specific alert

lenses-cli alert setting condition delete \
    --alert=2000 \
    --condition="7643d1ec-73f9-4913-95d1-87e62f1ec172"

# For "Data Produced" type of alert rules
alert setting condition delete \
    --alert 5000 \
    --condition=19e7791d-9fbf-4b6b-b198-8490e5e30d29

The value of the `--alert` flag is the Alert ID that the alert setting belongs to whereas the value of the `--condition` flag is the UUID of the condition to delete.

Alert Channels

This page describes managing alert channels in Lenses via the CLI.

List alert channels

lenses-cli alertchannels

View details of all alert channels

lenses-cli alertchannels --details

List alert channels with possible flags

lenses-cli alertchannels \
--page=1 \
--pageSize=10 \
--sortField="name" \
--sortOrder="asc" \
--templateName="test" \
--channelName="slack"

Create a new alert channel

lenses-cli alertchannels create \
--name "my-slack-channel" \
--connectionName="my-slack-connection" \
--templateName="Slack" \
--properties="[{\"key\":\"username\",\"value\":\"@johndoe\"},{\"key\":\"channel\",\"value\":\"company-slack-channel\"}]"

Create a new alert channel using a YAML file:

name: "My alert channel"
templateName: "Slack"
connectionName: "slackconn"
   properties:
   - key: "username"
     value: "George"
   - key: "channel"
     value: "#dev-ops"

lenses-cli alertchannels create alert_chann.yml

Update an alert channel

lenses-cli alert setting set \
    --id 1000 \
    --enable=false \
    --channels="143315dd-80bf-4833-a13a-394be06dd
    --channels="f9d6140c-4823-4157-a93c-5147aa0e2f29"

Update the settings of an alert channel from a file:

id: 1000
enable: false
channels:
- "f9d6140c-4823-4157-a93c-5147aa0e2f29"
- "143315dd-80bf-4833-a13a-394be06dda87"

lenses-cli alert setting set alert_sett.yaml

Delete an alert channel

lenses-cli alertchannels \
    delete channelID="f9d6140c-4823-4157-a93c-5147aa0e2f29"

Audit Channels

This page describes the commands to manage audit channels in Lenses via the CLI.

List audit channels

Basic list

lenses-cli auditchannels

Detailed view

lenses-cli auditchannels --details

List audit channels with possible flags

lenses-cli auditchannels \
--page=1 \
--pageSize=10 \
--sortField="name" \
--sortOrder="asc" \
--templateName="test" \
--channelName="slack"

List audit channel templates

When creating audit channels, one of the existing predefined channel templates needs to be used.

Such a command lists all available audit channel templates:

lenses-cli auditchannel-templates

To get all the details, use JSON format:

lenses-cli auditchannel-templates --output JSON

Create a new audit channel

lenses-cli auditchannels create \
  --name "my-audit-channel-1" \
  --connectionName="w1" \
  --templateName="Webhook" \
  --properties="[{\"key\":\"body\",\"value\":\"payload1-created\"},{\"key\":\"insecure\",\"value\":true},{\"key\":\"method\",\"value\":\"GET\"}]"

Create a new audit channel using a YAML file:

name: "my-audit-channel-2"
templateName: "Webhook"
connectionName: "w1"
properties:
  - key: "body"
    value: "body-payload"
  - key: "insecure"
    value: true
  - key: "method"
    value: "GET"

Save the file as audit_chann.yml and execute it like this:Copy

lenses-cli auditchannels create audit_chann.yml

Update an audit channel

lenses-cli auditchannels update \
  --id "ID_OF_THE_CHANNEL_TO_BE_UPDATED" \
  --name "my-audit-channel-2-updated" \
  --connectionName="w1" \
  --templateName="Webhook" \
  --properties="[{\"key\":\"body\",\"value\":\"payload1-created\"},{\"key\":\"insecure\",\"value\":true},{\"key\":\"method\",\"value\":\"GET\"}]"

Delete an audit channel

lenses-cli auditchannels delete \
    --channelID="701ff62c-8d14-4ef9-8dd0-fe2cd3c73779"

Connections

This page describes the commands to manage connections in Lenses via the CLI.

Viewing connections

lenses-cli connections

Viewing connection details

lenses-cli connections get --name connection-name

Creating a connection

lenses-cli connections create \
    --name SlackConnection \
    --template-name Slack \
    --tag slack \ --tag \connection --tag slack-connection \
    --connection-config '[{"key":"webhookUrl","value":"https://hooks.slack.com/"}]'

Consider using the provision for managing dynamic connections.

Update a connection

lenses-cli connections update --name SlackConnection \
    --tag slack --tag connection --tag slack-connection \
    --connection-config '[{"key":"webhookUrl","value":"https://hooks.slack.com/"}]'

Delete a connection

lenses-cli connections delete --name SlackConnection

Groups

This page describes the commands to manage Groups in Lenses via the CLI.

View groups

List the current user groups.

lenses-cli groups

View group

Get the details of a user group:

lenses-cli groups get --name Group1

Get the assigned data namespaces of a user group:

lenses-cli groups get --name Group1 --dataNamespaces

Create

Create a user group via the command line flags or file:

lenses-cli groups create \
    --name MyGroup \
    --description "My test group" \
    --applicationPermissions ViewKafkaConsumers \
    --applicationPermissions ManageKafkaConsumers \
    --applicationPermissions ViewConnectors \
    --connectClustersPermissions dev \
    --dataNamespaces '[{"wildcards":["*"],"permissions":["CreateTopic","DropTopic","ConfigureTopic","QueryTopic","ShowTopic","ViewSchema","InsertData","DeleteData","UpdateSchema"],"system":"Kafka","instance":"Dev"}]'

# from a file:
lenses-cli groups create ./group.yaml

Example file

name: MyGroup
description: "My test group"
applicationPermissions:
  - ViewKafkaConsumers
  - ManageKafkaConsumers
  - ViewConnectors
connectClustersPermissions:
  - dev
dataNamespaces:
  - wildcards:
      - "*"
    permissions:
      - CreateTopic
      - DropTopic
      - ConfigureTopic
      - QueryTopic
      - ShowTopic
      - ViewSchema
      - InsertData
      - DeleteData
      - UpdateSchema
    system: Kafka
    instance: Dev

Update

Update a user group:

lenses-cli groups update \
    --name MyGroup \
    --description "My test group" \
    --applicationPermissions ViewKafkaConsumers \
    --applicationPermissions ManageKafkaConsumers \
    --applicationPermissions ViewConnectors \
    --connectClustersPermissions dev \
    --dataNamespaces '[{"wildcards":["*"],"permissions":["CreateTopic","RequestTopicCreation", "DropTopic","ConfigureTopic","QueryTopic","ShowTopic","InsertData","DeleteData","UpdateSchema","ViewSchema"],"system":"Kafka","instance":"Dev"}]'

Delete

Delete a user group:

lenses-cli groups delete --name Group1

Clone

Clone a user group:

lenses-cli groups clone --name Group1 --cloneName Group1Cloned

Schemas

This page describes the commands to manage schemas in Lenses via the CLI.

View all schemas

View the current schemas registered:

The --unwrap flag is optional, prints only the names separated by new line

View a schema

Schemas can be filtered by name:

View schema versions

Schemas versions can be viewed filtered by name:

View schema compatibility levels

Schema compatibility levels can be viewed and filtered by name:

Delete schemas

Delete all versions of a schema by name:

Delete schemas by version

Delete a specific version of a schema:

Change the compatibility of a Schema

Change the compatibility level of a schema:

Register a schema

schema.yaml:

Service Accounts

This page describes the commands to manage Service Accounts in Lenses via the CLI.

The CLI can create, update, delete and revoke Lenses service accounts.

Create a service account

From a file:

Example file:

Update a service account

Update a service account via the command line flags or file:

Delete a service account

Revoke

Revoke a service account token and use your own custom token

License

This page describes the commands to manage a license in Lenses via the CLI.

View license info

Update the license of a Lenses instance at runtime

Users

This page describes the commands to manage Users in Lenses via the CLI.

Create a user

Example file:

Update a user

Delete a user

Change the password of a user

Find users by one group or many

Alerts

This page describes the commands to manage Lenses Alerts via the CLI.

View all raised alert notifications

Copy

lenses-cli alerts

View all alert settings

Copy

lenses-cli alert settings

View an alert setting

lenses-cli alert setting --id=2000

Enable or disable an alert setting

Enabling

lenses-cli alert setting --id=1000 --enable

Disabling

lenses-cli alert setting --id=1000 --enable=false

View all conditions that belong to a specific alert setting

lenses-cli alert setting conditions --alert=2000

Create or update an existing condition for a specific alert setting

lenses-cli alert setting condition set \
--alert=2000 \
--condition="lag >= 200000 on group groupA and topic topicA" \
--channels="f9d6140c-4823-4157-a93c-5147aa0e2f29"

# For "Data Produced" type of alert rules
lenses-cli alert setting condition set \
    --alert=5000 \
    --topic=my-topic \
    --duration=PT6H \
    --more-than=5

# optional channels can be used more than once
# You can get the ID of a channel with `lenses-cli alertchannels`
lenses-cli alert setting condition set \
    --alert=5000 \
    --topic=my-topic \
    --duration=PT6H \
    --more-than=5 \
    --channels="9176c428-be0e-4c36-aa1e-8b8a66782232" \
    --channels="7b184b13-f37c-4eee-9c0a-17dec2fd7bf5"

Update an existing condition using flags

lenses-cli alert setting condition set --alert 2000 \
    --condition="lag >= 95 on group group-1 and topic topic-1" \
    --conditionID="5a6c3951-dfde-478e-8952-8193e62a9a8a" \
    --channels="143315dd-80bf-4833-a13a-394be06dda87" \
    --channels="f9d6140c-4823-4157-a93c-5147aa0e2f29"

# For "Data Produced" type of alert rules
# update - identify rule to update by its condition ID
lenses-cli alert settings --query="categories.producers" | jq .

lenses-cli alert setting condition set \
    --conditionID=f4a623e3-5287-4ca3-9d05-8f0ab68a9b4b \
    --alert=5000 \
    --topic=my-topic \
    --duration=PT6H \
    --more-than=5

Create or update a condition from a file

cat > alert_cond.yaml <<- "EOF"
alert: 2000
conditionID: "5a6c3951-dfde-478e-8952-8193e62a9a8a"
condition:
  "lag >= 30 on group schema-registry and topic backblaze_smart"
channels:
  - "143315dd-80bf-4833-a13a-394be06dda87"
  - "f9d6140c-4823-4157-a93c-5147aa0e2f29"
EOF

lenses-cli alert setting condition set alert_cond.yaml

# For "Data Produced" type of alert rules
cat > data_produced_alert.yaml <<- "EOF"
topic: "my-yaml-topic"
alert: 5000
more-than: 6990
duration: "PT6H"
EOF

lenses-cli alert setting condition set data_produced_alert.yml

Command line flags are ignored when loading from files.

Delete an existing condition for a specific alert

lenses-cli alert setting condition delete \
    --alert=2000 \
    --condition="7643d1ec-73f9-4913-95d1-87e62f1ec172"

# For "Data Produced" type of alert rules
alert setting condition delete \
    --alert 5000 \
    --condition=19e7791d-9fbf-4b6b-b198-8490e5e30d29

The value of the `--alert` flag is the Alert ID that the alert setting belongs to whereas the value of the `--condition` flag is the UUID of the condition to delete.