Setting Up Event Management Agents to Upload Scanned Files

Upload Scan File mode uses two Event Management Agents:

  • A standalone agent has a connection to one or more runtime event brokers and, optionally, a Confluent Schema Registry. The standalone agent runs the discovery scan.

  • A connected agent has a connection to Event Portal. You copy the scan file from the standalone agent to the connected agent and upload it to Event Portal manually.

You may choose Upload Scan File mode for several use cases, including:

  • You want to import runtime event broker data into additional tools that support AsyncAPI specifications.

  • Your organization's policies don't allow you to connect Event Portal to your event brokers.

  • You want to redact sensitive data from scan files before manually uploading the data to Event Portal.

Upload Scan File mode does not support enabling runtime configuration from Event Portal. For more information, see Configuring Event Brokers in Event Portal.

Prerequisites

You can install the two Event Management Agent instances on the same computer or two separate computers. The computers where you set up Event Management Agents must meet these requirements:

  • at least one CPU and one GB of RAM

  • either Docker or Java 17.

  • the standalone agent that performs the discovery scan requires network access to the event brokers that you want to discover runtime data from, and to any Confluent Schema Registries that you want to get schema data from

  • the connected agent that uploads scan data to Event Portal must have Internet access to connect to Event Portal

For network performance, Solace recommends installing standalone Event Management Agents in proximity to the runtime event brokers that they scan.

You can install Event Management Agents using Docker or Java by following the instructions available in Runtime Event Manager. Solace recommends using Docker unless your security requirements don't allow you to do so.

The required Event Management Agent files are also available for download in the Solace Products GitHub repository. Instructions to install and use the Event Management Agent are also in the GitHub repository. Solace recommends using the procedure documented here and in the Runtime Event Manager.

Setting Up the Event Management Agents

You can view instructions to set up Event Management Agents in Runtime Event Manager. After you Set up an Event Management Agent connection, you can proceed directly to setting up the Event Management Agents, or you can return to the set up at a later time.

To set up Event Management Agents for Upload Scan File mode, perform these steps:

  1. On the navigation bar, select Runtime Event Manager .
  2. Click More Actions > Manage Event Management Agents.
  3. Click More Actions for the Event Management Agent connection that you want to set up the agents for and select Install Event Management Agent.
  4. Follow the instructions on the Install Event Management Agent page:
    1. Select whether you are using Docker or Java.
    2. Pull the Docker image or download/copy the latest version of the JAR file to the computers where you will install the standalone and connected agents.
    3. Click Download to download the Event Management Agent connection file for the Standalone agent that connects to your runtime event brokers. Make sure that the filename doesn't contain spaces or special characters, or that it is wrapped in quotation marks to avoid OS-related filename errors.
    4. Click Download to download the Event Management Agent connection file for the Connected agent that connects to Event Portal. Make sure that the filename doesn't contain spaces or special characters, or that it is wrapped in quotation marks to avoid OS-related filename errors.
  5. Click Complete Installation Setup.
  6. The Run and Upload Discovery Scan page opens. You can follow the instructions to run a discovery scan and upload it to Event Portal, or click Finish to close the page.

Running and Uploading a Discovery Scan

To run a discovery scan and upload the data into Event Portal, perform these steps:

  1. On the navigation bar, select Runtime Event Manager .
  2. Click More Actions > Manage Event Management Agents.
  3. Click More Actions for the Event Management Agent that you want to use to run a discovery scan and select Run and Upload Discovery Scan.
  4. Follow the instructions on the Run and Upload Discovery Scan page:
    1. Select whether you are using Docker or Java.
    2. Follow the instructions on the page to run the scan using either the Docker CLI or Java. For more information about setting a custom scan type, see Scan Types.
    3. Copy the scan file from the standalone Event Management Agent to the connected Event Management Agent.
    4. (Optional). If necessary, delete any sensitive data that you don't want to upload to Event Portal from the scan file.
    5. Follow the instructions on the page to upload the scan file to Event Portalusing the connected agent.
  5. Click Finish to close the page.
  6. Go to the Audit tab for the modeled event mesh containing the model event brokers to verify that your data uploaded successfully.

Scan Types

The scanTypes parameter specifies what the Event Management Agent scans. It has the following values:

Solace
  • SOLACE_QUEUE_CONFIG: Solace queue configurations
  • SOLACE_QUEUE_LISTING: Solace queue listing
  • SOLACE_SUBSCRIPTION_CONFIG: Solace subscription configurations
  • SOLACE_ALL: All of the above
Kafka
  • KAFKA_BROKER_CONFIGURATION: Kafka broker configurations
  • KAFKA_CLUSTER_CONFIGURATION: Kafka cluster configurations
  • KAFKA_CONSUMER_GROUPS: Kafka consumer groups
  • KAFKA_CONSUMER_GROUPS_CONFIGURATION: Kafka consumer group configurations
  • KAFKA_FEATURES: Kafka feature
  • KAFKA_PRODUCERS: Kafka producers
  • KAFKA_TOPIC_CONFIGURATION: Kafka topic configurations
  • KAFKA_TOPIC_CONFIGURATION_FULL: Kafka topic configurations full
  • KAFKA_TOPIC_LISTING: Kafka topic listing
  • KAFKA_TOPIC_OVERRIDE_CONFIGURATION: Kafka topic override configurations
  • KAFKA_ALL: All of the above
Confluent Schema Registry:
  • CONFLUENT_SCHEMA_REGISTRY_SCHEMA: Confluent Registry schemas

Viewing the Event Management Agent Logs

The Event Management Agent logs can help you monitor Event Management Agent output and know when the Event Management Agent is ready. You can get the logs from Docker using the following command.

docker logs -f event-management-agent

If you used Java to install the Event Management Agent and run discovery scans, the logs are available in the terminal.