Setting Up a Connected Event Management Agent

When you set up an Event Management Agent in Connected mode, you use one Event Management Agent that is connected to Event Portal, one or more runtime event brokers, and optionally, a Confluent Schema Registry. This mode allows you to perform the following tasks:

Send application and queue configuration data to Solace event brokers.
Run discovery scans from Event Portal and upload the scanned data automatically.

The instructions on this page assume you are using Docker to set up the Event Management Agent. You can set up the agent on your own following these instructions, or you can let Runtime Event Manager walk you through the set up after you finish setting up the Event Management Agent connection.

The Event Management Agent files are also available in the Solace Products GitHub repository. Instructions to install an Event Management Agent and use it to scan event brokers are available in the GitHub repository. Solace recommends using Docker to install and use an Event Management Agent with Event Portal.

Prerequisites

For network performance, Solace recommends setting up Event Management Agents in proximity to the runtime event brokers that they connect to. The computer where you set up Event Management Agents must meet these requirements:

A computer with at least 1 CPU and 1 GB of RAM
Docker

To use Connected mode, the computer requires network access to Event Portal, your event brokers that you want to configure or discover runtime data from, and to any Confluent Schema Registries that you want to get subject data from.
If the Event Management Agent needs to use a web proxy to connect to Event Portal, you need the connection details for the proxy server. For more information, see Configuring an Event Management Agent to Connect Through a Proxy.

Installing an Event Management Agent

To install an Event Management Agent with a connection to Event Portal, perform these steps:

Follow the instructions for Setting Up an External Connection for the event broker and select Connected mode.

When you finish setting up the connection, the Install Event Management Agent page opens.
In step 1 on the page, download the Event Management Agent connection file. Make sure that the filename doesn't contain spaces or special characters, or wrap it in quotation marks to avoid OS-related filename errors.
If you are not using a web proxy, copy the Docker run command displayed in step 2 and paste it into your OS terminal with the following changes:
- Replace /path/to/file/AcmeRetail.yml with the path to your connection file.
- Replace PASSWORD_ENV_VAR_1 with the appropriate password environment variable name.
- Replace envVarPassword1 with the password for the event broker.
```
export PASSWORD_ENV_VAR_1=envVarPassword1

docker run -d -p 8180:8180 -v /absolute/path/to/your/ema/config.yml:/config/ema.yml \
--env Placeholder_SOLACE_SEMP_PASSWORD=${PASSWORD_ENV_VAR_1} \
--name event-management-agent solace/event-management-agent:latest
```

If you are using a web proxy, copy the Docker run command displayed in step 3 and paste it into your OS terminal with the following changes:

Replace your_proxy_host with the URL for the proxy.
Replace your_proxy_port with the port number for the proxy.
Replace your_username with the username required to connect to the proxy. If the Event Management Agent can connect to the proxy without authentication, you can instead remove this line.
Replace your_password with the password required to connect to the proxy. If the Event Management Agent can connect to the proxy without authentication, you can instead remove this line.
Replace envVarPassword1 with the password for the event broker.
Replace /path/to/file/AcmeRetail.yml with the path to your connection file.
Replace PASSWORD_ENV_VAR_1 with the appropriate password environment variable name.

export EMA_SOLACE_PROXY_ENABLED=true
export EMA_SOLACE_PROXY_TYPE=http
export EMA_SOLACE_PROXY_HOST=your_proxy_host
export EMA_SOLACE_PROXY_PORT=your_proxy_port
export EMA_SOLACE_PROXY_USERNAME=your_username
export EMA_SOLACE_PROXY_PASSWORD=your_password
export PASSWORD_ENV_VAR_1=envVarPassword1

docker run -d -p 8180:8180 -v /absolute/path/to/your/ema/config.yml:/config/ema.yml \
--env SOLACE_PROXY_ENABLED=${EMA_SOLACE_PROXY_ENABLED} \
--env SOLACE_PROXY_TYPE=${EMA_SOLACE_PROXY_TYPE} \
--env SOLACE_PROXY_HOST=${EMA_SOLACE_PROXY_HOST} \
--env SOLACE_PROXY_PORT=${EMA_SOLACE_PROXY_PORT} \
--env SOLACE_PROXY_USERNAME=${EMA_SOLACE_PROXY_USERNAME} \
--env SOLACE_PROXY_PASSWORD=${EMA_SOLACE_PROXY_PASSWORD} \
--env Placeholder_SOLACE_SEMP_PASSWORD=${PASSWORD_ENV_VAR_1} \
--name event-management-agent solace/event-management-agent:latest

Start the agent using the Docker run command in your OS terminal.
If you are following the instructions in the Cloud Console, click Finish.

After the setup is complete, you can run discovery scans from the associated modeled event meshes and configure Solace event brokers from Event Portal.

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

Provide feedback