Event Forwarders

Security Requirements and Controls

Event Forwarders define the Kafka server and topic that events are forwarded to. They are owned at the organization level, and can be shared across repositories in that organization. You can manage event forwarders from the Event Forwarder page, which allows you to create, edit and delete Event Forwarders.

Note

You need root access to perform these actions. See Manage root access for more information.

Screenshot of the LogScale Event Forwarder user interface showing a tabular list of configured event forwarders. The interface displays forwarder properties including names, descriptions, associated topics, and status indicators. The table includes action controls for managing forwarders, with options to create new forwarders, edit existing configurations, or delete them. This management interface allows administrators to configure where events from LogScale repositories will be forwarded to external systems like Kafka.

Figure 8. Event Forwarder UI


Configuring Event Forwarders

  1. Click the User Icon (upper right corner) and select Organization settings.

  2. Under Assets in the side menu, click Event forwarders.

  3. On the Event forwarders page, click New event forwarder. A pop-up will open.

    Screenshot of the LogScale event forwarder configuration dialog box showing the form for creating a new Kafka event forwarder. The interface displays input fields for essential configuration parameters including: a name field for identifying the forwarder, an optional description field for documentation purposes, a topic field for specifying the Kafka topic name, and a properties text area for entering Kafka producer configuration parameters such as bootstrap.servers. The dialog also includes an 'Enable event forwarder' checkbox (selected by default), a 'Test event forwarder' button for connection validation, and action buttons to either create the forwarder or cancel the operation.

    Figure 9. Event Forwarder Details


  4. Specify the following fields:

    • Name — The name of your event forwarder.

    • Description (optional) — This is optional but allows you to specify a description of your event forwarder which may be useful when the event forwarder is shared.

    • Topic — Specify a name for a new topic and then this topic will be created on the Kafka cluster or provide the name of topic that has already been created on the Kafka cluster.

    • Properties — Specify the properties to configure the Kafka producer. You must specify at least the bootstrap.servers property.

  5. Optionally deselect the Enable event forwarder checkbox to create the forwarder in a disabled state.

  6. Optionally click Test event forwarder to test the configuration.

  7. Click Create event forwarder to create the forwarder.

Kafka Configuration

To configure an Event Forwarder, you must specify the Kafka topic as well as the properties for the Kafka producer. You must also specify at least the bootstrap.servers property.

Below are some example properties:

ini
bootstrap.servers=localhost:3456
batch.size=100

LogScale configures a Kafka producer based on these properties. You are responsible for setting up the Kafka server and creating the topic separately.

Warning

  • Kafka producer properties must be appropriately sized for the volume of data being forwarded. An incorrectly configured producer (for example, with inappropriate batch sizes or buffer settings) can cause excessive CPU consumption on the LogScale node, which can indirectly degrade LogScale performance including ingest throughput.

  • If you use the same Kafka server(s) for Event Forwarding as you use for LogScale's internal operations, ensure the cluster has sufficient resources to handle both workloads. Resource contention on a shared Kafka cluster can degrade LogScale performance.

Editing and Deleting Event Forwarders

You can edit and delete Event Forwarders from the Event Forwarders page.

Note

You cannot delete an Event Forwarder that has event forwarding rules associated to it. You must remove the forwarder from all associated rules before deletion. If you try to delete a forwarder with rules attached, you see an error message listing the rules that reference it.

  1. Click the User Icon (upper right corner) and select Organization settings.

  2. Under Assets in the side menu, click Event forwarders.

  3. On the Event forwarders page, click the three dots next to the Event Forwarder you want to edit or delete, and click either Edit forwarder or Delete.

    Screenshot of the LogScale Event Forwarders management interface showing the action menu that appears when clicking the three-dot menu icon next to an existing event forwarder entry. The dropdown menu displays two options: 'Edit forwarder' which opens the configuration dialog for modifying the forwarder's settings, and 'Delete' which initiates the removal process for the selected forwarder. The interface shows a tabular list of configured event forwarders in the background, with this contextual menu overlaid on top. This menu is the entry point for administrators to modify existing Kafka event forwarder configurations or remove forwarders that are no longer needed.

    Figure 10. Edit/Delete Event Forwarder


  4. If you are editing a forwarder, click Save changes to save the changes. If you are attempting to delete, you must confirm the operation in the pop-up.

Event Forwarder APIs

Event Forwarders can be managed via the GraphQL API. See GraphQL API for full reference.

You can use the following queries for event forwarders:

  • eventForwarders()

You can also use the following mutations:

Note

Root access is required to use these APIs, see Manage root access for more details.