Event Streams

• 1: Overview
• 1.1: Server Type
• 1.2: Monitoring Metrics
• 1.3: ServiceWatch Metrics
• 2: How-to guides
• 3: API Reference
• 4: CLI Reference
• 5: Release Note

1 - Overview

Service Overview

Event Streams provides fully managed creation and configuration of the open-source Apache Kafka for large-scale, high-volume message data processing. Samsung Cloud Platform automates the creation and configuration of Apache Kafka through a web-based console, allowing users to configure the main components of Apache Kafka—Broker, Zookeeper, and AKHQ—in either a single or clustered setup.

The Event Streams cluster consists of multiple Broker nodes; you can install between 1 and 10 Brokers, typically deploying three or more. Zookeeper can be installed separately to manage the distributed Brokers, but if not installed separately, it is installed on the Broker nodes. Additionally, we provide AKHQ (Apache Kafka HQ), a tool for managing Kafka, allowing users to perform cluster operation and management through it.

Provided features

Event Streams provides the following features.

• Auto Provisioning: You can configure and set up an Apache Kafka cluster via the UI.
• Operation Control Management: Provides functionality to control the status of running servers. In addition to starting and stopping the cluster, restarting is possible to apply configuration changes.
• AKHQ provision: We provide AKHQ, a tool for managing Kafka, enabling users to manage and monitor clusters.
• Add Broker node: If expansion is required to improve cluster performance and stability, you can add a node with the same specifications as the existing Broker nodes.
• Parameter management: You can configure and modify parameters related to performance improvement and security.
• Monitoring: CPU, memory, performance monitoring information can be accessed via Cloud Monitoring and Servicewatch.

Component

Event Streams provides pre‑validated engine versions and various server types in accordance with its open‑source support policy. Users can select and use them based on the scale of the service they wish to configure.

Engine version

The engine versions supported by Event Streams are as follows.

Technical support can be used until the supplier’s EoTS (End of Technical Service) date, and the EOS date when new creation is stopped is set to six months before the EoTS date.

The EOS and EoTS dates may change according to the supplier’s policy, so please refer to the supplier’s license management policy page for details.

• Apache Kafka: https://docs.confluent.io/platform/current/installation/versions-interoperability.html

Server Type

The server types supported by Event Streams are as follows.

For detailed information about the server types provided by Event Streams, refer to Event Streams Server Types.

Standard ess1v2m4

Preliminary Service

This is a list of services that must be pre-configured before creating the service. Please refer to the guide provided for each service and prepare in advance.

1.1 - Server Type

Event Streams server type

Event Streams provides server types composed of various combinations such as CPU, Memory, and Network Bandwidth. When creating Event Streams, Apache kafka is installed according to the server type selected for the intended purpose.

The server types supported by Event Streams are as follows.

Standard ess1v2m4

ess1 server type

The ess1 server type of Event Streams is offered with standard specifications (vCPU, Memory) and is suitable for various database workloads.

• Intel 3rd‑generation (Ice Lake) Xeon Gold 6342 Processor up to 3.3 GHz
• Supports up to 16 vCPUs and 64 GB of memory
• Maximum networking speed of 12.5 Gbps

ess2 server type

The ess2 server type of Event Streams is offered with standard specifications (vCPU, Memory) and is suitable for various database workloads.

• Intel 4th‑generation (Sapphire Rapids) Xeon Gold 6448H Processor up to 3.2 GHz
• Supports up to 16 vCPUs and 64 GB of memory
• Maximum networking speed of 12.5 Gbps

esh2 server type

The esh2 server type of Event Streams is offered with high-capacity server specifications and is suitable for database workloads that require large-scale data processing.

• Intel 4th‑generation (Sapphire Rapids) Xeon Gold 6448H Processor up to 3.2 GHz
• Supports up to 32 vCPUs and 128 GB of memory
• Up to 25 Gbps networking speed

1.2 - Monitoring Metrics

Event Streams monitoring metrics

The table below shows the performance monitoring metrics for Event Streams that can be viewed through Cloud Monitoring. For detailed Cloud Monitoring usage, see the Cloud Monitoring guide.

For Event Streams server monitoring metrics, refer to the Virtual Server Monitoring Metrics guide.

1.3 - ServiceWatch Metrics

Event Streams sends metrics to ServiceWatch. The metrics provided by default monitoring are data collected at 1‑minute intervals.

Basic Metrics

The following are the basic metrics for the Event Streams namespace.

Indicators whose names are shown in bold below are the indicators selected as key metrics among the default metrics provided by Event Streams. Key metrics are used to build service dashboards that are automatically created for each service in ServiceWatch.

Each metric provides guidance in the user guide about which statistical value is meaningful when querying that metric, and among the meaningful statistics, the statistical values displayed in bold text are the primary statistics. In the service dashboard, primary metrics can be viewed using the primary statistical values.

OS Basic Metrics

Event Streams basic metrics

2 - How-to guides

Users can create the service by entering the required information for Event Streams and selecting detailed options through the Samsung Cloud Platform Console.

Create Event Streams

You can create and use the Event Streams service in the Samsung Cloud Platform Console.

To create Event Streams, follow these steps.

1. All Services > Data Analytics > Event Streams click the menu. 1. Navigate to the Service Home page of Event Streams.

2. On the Service Home page, click the Create Event Streams button. 2. Go to the Create Event Streams page.

3. Event Streams creation page, enter the information required to create the service and select detailed options.

   • Select the required information in the Image and version selection area.

     Category	required status	Detailed description
     Image version	Required	Provide a list of Event Streams versions

     Table. Event Streams service information input items
   • In the Service Information Input area, enter or select the required information.

     Category	required status	Detailed description
     Server name Prefix	Required	The server name where Apache Kafka will be installed must start with a lowercase English letter and be entered using lowercase letters, numbers, and the special character (-) with a length of 3 to 13 characters A postfix such as 001, 002 is appended to the base server name to generate the actual server name
     Cluster name	Required	Cluster name of the servers Enter using English letters, 3 ~ 20 characters A cluster is a unit that groups multiple servers
     Broker > Number of Broker Nodes	Required	Number of Broker Nodes
     Broker > server type	Required	Server type for installing the Broker Standard: Standard specification commonly used High Capacity: Large-capacity server with 24 vCores or more For detailed information about the server types provided by Event Streams, see Event Streams server types.
     Broker > Planned Compute	Select	Status of resources with Planned Compute configured In Use: Number of resources with Planned Compute that are currently in use Configured: Number of resources with Planned Compute configured Coverage Preview: Amount applied per resource by Planned Compute Apply for Planned Compute Service: Go to the Planned Compute service application page For more details, see Planned Compute 신청하기
     Broker > Block Storage	Required	Block Storage type to be used for the Broker node Base OS: The area where the engine is installed DATA: Data file storage area Select the storage type and then enter the capacity (for details on each Block Storage type, see Block Storage 생성하기) SSD: High‑performance general volume HDD: General volume SSD_KMS/HDD_KMS: Additional encrypted volume using Samsung Cloud Platform KMS (Key Management System) encryption keys Enter the capacity as a multiple of 8 within the range 16 to 5,120
     Zookeeper separate installation > use	Select	Whether to install Zookeeper nodes separately If you select Use, install Zookeeper nodes separately If Zookeeper nodes are not installed separately, the Broker node also performs the Zookeeper role
     Zookeeper separate installation > server type	Select	Server type on which Zookeeper will be installed Zookeeper nodes provide vCPU 1, Memory 2G or vCPU 2, Memory 4G
     Zookeeper separate installation > Planned Compute	Select	Status of resources with Planned Compute configured In Use: Number of resources with Planned Compute that are currently in use Configured: Number of resources with Planned Compute configured Coverage Preview: Amount applied per resource by Planned Compute Apply for Planned Compute Service: Go to the Planned Compute service application page For more details, see Planned Compute Apply
     Separate Zookeeper installation > Block Storage	Required	Block Storage type to be used for Zookeeper nodes Default OS: Area where the engine is installed DATA: Data file storage area After selecting the storage type, enter the capacity (see Block Storage 생성하기 for details on each Block Storage type) SSD: High‑performance general volume HDD: General volume SSD_KMS/HDD_KMS: Additional encrypted volume using Samsung Cloud Platform KMS (Key Management System) encryption keys Enter the capacity as a multiple of 8 within the range 16 to 5,120
     AKHQ > Use	Required	Whether to install AKHQ If you select Use, AKHQ will be installed
     AKHQ > Server Type	Required	Server type on which AKHQ will be installed AKHQ only provides the vCPU 2, Memory 4G type
     AKHQ > Planned Compute	Select	Status of resources with Planned Compute configured In Use: Number of resources with Planned Compute that are currently in use Configured: Number of resources with Planned Compute configured Coverage Preview: Amount applied per resource by Planned Compute Apply for Planned Compute Service: Go to the Planned Compute service application page For more details, see Planned Compute 신청하기
     AKHQ > Block Storage	Required	Block Storage type to be used on the server where AKHQ is installed Base OS: area where the engine is installed
     AKHQ > AKHQ account	Required	AKHQ account Enter using lowercase English letters, 2 ~ 20 characters
     AKHQ > AKHQ password	Required	AKHQ account password English letters, numbers, and special characters (“ ‘ excluded) including 8 ~ 30 characters
     AKHQ > Verify AKHQ password	Required	Confirm AKHQ account password Re-enter the AKHQ account password identically
     AKHQ > AKHQ Port number	Required	AKHQ connection port number The port number is automatically set to 8080 and cannot be modified
     Network > Common Settings	Required	Network settings for servers created by the service Select when you want to apply the same settings to all installed servers Select a pre‑created VPC and Subnet IP: only automatic generation is possible For Public NAT settings, it is only possible in per‑server configuration
     Network > Server-specific Settings	Required	Network settings where servers generated by the service are installed Select if you want to apply different settings per installed server Select a pre‑created VPC and Subnet IP: Enter the IP for each server Public NAT feature is available only when the VPC is connected to an Internet Gateway; checking Use allows selection from the reserved IPs in the VPC product’s Public IP pool. For details, see Public IP 생성하기
     IP access control	Select	Service Access Policy Configuration Since the access policy is set for the IP entered on the page, you do not need to configure a separate Security Group policy Enter the IP in IP format (e.g., 192.168.10.1) or CIDR format (e.g., 192.168.10.0/24, 192.168.10.1/32) and click the Add button To delete an entered IP, click the x button next to the IP
     maintenance period	Select	Event Streams maintenance window If you select Use, set the day of week, start time, and duration It is recommended to set a maintenance window for stable service management. Patch operations will be performed at the scheduled time, and service interruption may occur We are not responsible for issues arising from patches not being applied (set as not used)

     Table. Event Streams service configuration items
   • Enter required database configuration information In this area, enter or select the required information.

     Category	required status	Detailed description
     Zookeeper SASL account	Required	Zookeeper account Enter using lowercase English letters, 2 to 20 characters
     Zookeeper SASL password	Required	Zookeeper account password including English letters, numbers, and special characters (“ ‘ excluded) and enter 8 to 30 characters
     Check Zookeeper SASL password	Required	Verify Zookeeper account password Re-enter the Zookeeper SASL account password identically
     Zookeeper Port number	Required	Zookeeper port number 1200 ~ 65535 must be entered as one of them, and the Broker port or 2888, 3888 cannot be used
     Broker SASL account	Required	Kafka login account Enter using lowercase English letters, 2 ~ 20 characters
     Broker SASL password	Required	Kafka login account password Enter 8 to 30 characters, including English letters, numbers, and special characters (excluding “ ‘)
     Verify Broker SASL password	Required	Verify Kafka connection account password Re-enter the Broker SASL account password identically
     Broker Port number	Required	Kafka port number 1200 ~ 65535 can be entered as one of , and the Broker port or 2888, 3888 cannot be used
     Parameter	Required	Event Streams configuration parameters View button can be clicked to view detailed information of the parameters Parameters can be modified after the service creation is complete, and a restart is required when modified
     time zone	Select	Standard time zone for the service
     ServiceWatch log collection	Select	ServiceWatch log collection status Use to configure the ServiceWatch log collection feature For details about the collected logs, refer to ServiceWatch 지표 It is provided free of charge up to 5 GB for all services within the account, and charges apply based on storage usage for amounts exceeding 5 GB When collecting, log groups and log streams are created automatically, and they cannot be deleted until the resources are removed To prevent exceeding 5 GB, it is recommended to delete log data directly or shorten the retention period

     Table. Required input items for configuring Event Streams Database
   • In the Additional Information Input area, enter or select the required information.

     Category	required status	Detailed description
     tag	Select	Add Tag Add Tag Click the button to create and add a tag, or add an existing tag You can add up to 50 tags The newly added tags are applied after the service creation is completed

     Table. Event Streams service additional information input fields

4. Summary Check the detailed information and estimated charges generated in the panel, and click the Create button.

   • Once creation is complete, check the created resource on the Resource List page.

View Event Streams details

The Event Streams service lets you view and modify the complete list of resources and their detailed information. The Event Streams Details page consists of the Details, Tags, Activity Log tabs.

To view detailed information about the Event Streams service, follow these steps.

1. All Services > Data Analytics > Event Streams Click the menu. 1. Navigate to the Service Home page of Event Streams.
2. On the Service Home page, click the Event Streams menu. 2. Go to the Event Streams list page.
3. On the Event Streams List page, click the resource to view detailed information. 3. Go to the Event Streams Details page.
   • Event Streams Details At the top of the page, status information and additional feature details are displayed.

     Category	Detailed description
     Cluster status	Cluster status Creating: The cluster is being created Editing: The cluster is being changed to an operational state Error: The cluster encountered a failure while performing a task If this persists, contact the administrator Failed: The cluster failed during creation Restarting: The cluster is restarting Running: The cluster is operating normally Starting: The cluster is starting Stopped: The cluster is stopped Stopping: The cluster is stopping Synchronizing: The cluster is synchronizing Terminating: The cluster is being terminated Unknown: The cluster status is unknown If this persists, contact the administrator Upgrading: The cluster is being upgraded
     Cluster control	Button to change the cluster state Start: Start a stopped cluster Stop: Stop a running cluster Restart: Restart a running cluster
     See more features	Cluster management buttons Service status synchronization: Retrieve the current server status and synchronize it to the Console Parameter management: View and modify service configuration parameters Add Broker Node: Add a Broker Node When configured as a cluster, the Add Broker Node button is displayed
     Service cancellation	Cancel service button

     Table. Event Streams status information and additional features

Detailed information

Event Streams List page allows you to view detailed information of the selected resource and, if necessary, edit the information.

tag

Event Streams List page lets you view the tag information of the selected resource, and you can add, modify, or delete it.

Work History

On the Event Streams List page, you can view the operation history of the selected resource.

Managing Event Streams Resources

If you need to change the existing configuration options of a created Event Streams resource, manage parameters, or add a Broker Node configuration, you can perform the tasks on the Event Streams Details page.

Control operation

If changes occur to a running Event Streams resource, you can start, stop, or restart it.

To control the operation of Event Streams, follow these steps.

1. All Services > Data Analytics > Event Streams Click the menu. 1. Navigate to the Service Home page of Event Streams.
2. On the Service Home page, click the Event Streams menu. 2. Go to the Event Streams list page.
3. On the Event Streams list page, click the resource you want to control. 3. Go to the Event Streams Details page.
4. Check the Event Streams status and complete the change using the control button below.
   • Start: Event Streams service is installed on the server and the Event Streams service is running (Running).
   • Stop: The server where the Event Streams service is installed and the Event Streams service will be stopped (Stopped).
   • Restart: Only the Event Streams service will be restarted.

Synchronize service status

You can query the current server status and synchronize it to the Console.

To synchronize the service status of Event Streams, follow these steps.

1. All Services > Data Analytics > Event Streams Click the menu. 1. Navigate to the Service Home page of Event Streams.
2. On the Service Home page, click the Event Streams menu. 2. Go to the Event Streams list page.
3. On the Event Streams List page, click the resource to view the service status. 3. Go to the Event Streams Details page.
4. Service Status Sync Click the button. 4. The query takes a short amount of time, and while it is being performed, the cluster changes to the Synchronizing state.
5. When the query completes, the status in the server information field is updated, and the cluster changes to the Running state.

Manage Parameters

Provides parameter lookup and edit functionality.

To view and modify configuration parameters, follow the steps below.

1. Click the All Services > Data Analytics > Event Streams menu. 1. Navigate to the Service Home page of Event Streams.
2. On the Service Home page, click the Event Streams menu. 2. Navigate to the Event Streams list page.
3. On the Event Streams List page, click the resource whose parameters you want to view and edit. 3. Go to the Event Streams Details page.
4. Click the Parameter Management button. 4. Go to the Parameter Management page.
5. On the Parameter Management page, click the Search button. 5. Database query The popup window opens.
6. To view the Parameter information, click the Confirm button. 6. Retrieving may take a short amount of time.
   • You can modify the Parameter information after performing a query.
7. To edit the Parameter information, click the Edit button and then enter the changes in the Custom Value field of the Parameter you want to modify.
   • When the Application Type is Dynamic, it takes effect immediately, and when it is Static, a service restart is required, causing service interruption.
8. When the input is complete, click the Save button.

Change server type

You can change the configured server type.

To change the server type, follow these steps.

1. All Services > Data Analytics > Event Streams Click the menu. 1. Navigate to the Service Home page of Event Streams.
2. On the Service Home page, click the Event Streams menu. 2. Event Streams List navigate to the page.
3. On the Event Streams list page, click the resource whose server type you want to change. 3. Go to the Event Streams Details page.
4. Click the Edit button for the server type you want to change at the bottom of the detailed information. 4. Edit Server Type popup window opens.
5. Server Type Edit After selecting the server type in the popup window, click the Confirm button.

Expand storage

Storage added to the data area can be expanded up to a maximum of 5 TB based on the initially allocated capacity. You can expand storage without stopping Event Streams, and when configured as a cluster, all nodes are expanded simultaneously.

To increase storage capacity, follow the steps below.

1. All Services > Data Analytics > Event Streams click the menu. 1. Navigate to the Service Home page of Event Streams.
2. On the Service Home page, click the Event Streams menu. 2. Go to the Event Streams list page.
3. On the Event Streams list page, click the resource for which you want to change the server type. 3. Go to the Event Streams Details page.
4. Click the Edit button for the added Disk you want to expand at the bottom of the detailed information. 4. Disk Edit The popup window opens.
5. Disk Edit After entering the expanded capacity in the popup window, click the Confirm button.

Add Broker Node

If you need to expand the Event Streams cluster, you can add nodes with the same specifications as the Broker Node you are using. The added nodes are incorporated into the existing cluster without server downtime, and the existing data is automatically redistributed.

To add a Broker node, follow these steps.

1. All Services > Data Analytics > Event Streams menu, please click. 1. Navigate to the Service Home page of Event Streams.
2. On the Service Home page, click the Event Streams menu. 2. Go to the Event Streams list page.
3. On the Event Streams resource list page, click the resource you want to recover. 3. Navigate to the Event Streams Details page.
4. Click the Add Broker Node button. 4. Go to the Add Broker Node page.
5. After entering the relevant information in the Enter required information area, click the Complete button.

   Category	required status	Detailed description
   Server name	Required	The server name where the Broker is installed It is set to the server name configured in the original cluster.
   Cluster name	Required	Cluster name It is set to the cluster name configured in the original cluster.
   Additional Node Count	Required	Number of Nodes to add Use up to 10 nodes per cluster
   Service Type > Server Type	Required	The server type on which the Broker will be installed is set to be the same as the server type configured in the original cluster.
   Service Type > Planned Compute	Select	Status of resources with Planned Compute configured In Use: Number of resources with Planned Compute that are currently in use Configured: Number of resources with Planned Compute configured Coverage Preview: Amount applied per resource by Planned Compute Apply for Planned Compute Service: Go to the Planned Compute service application page For more details, see Planned Compute 신청하기
   Service Type > Block Storage	Required	Block Storage settings for the Broker node The storage type and capacity configured in the original cluster are applied identically
   Network	Required	The network on which the servers are installed is applied identically to the network configured in the original cluster

   Table. Additional items for Event Streams Broker Node

Cancel Event Streams

You can cancel unused Event Streams to reduce operating costs. However, if you terminate the service, the running service may be stopped immediately, so you should proceed with the termination only after fully considering the impact that may arise from service interruption.

To cancel Event Streams, follow these steps.

1. All Services > Data Analytics > Event Streams Click the menu. 1. Navigate to the Service Home page of Event Streams.
2. On the Service Home page, click the Event Streams menu. 2. Go to the Event Streams list page.
3. On the Event Streams List page, select the resource to cancel and click the Cancel Service button.
4. After the termination is complete, check on the Event Streams list page whether the resource has been terminated.

3 - API Reference

4 - CLI Reference

5 - Release Note

Event Streams