Akamai Event Viewer collector

[ 1 Configuration requirements ] [ 2 Overview ] [ 3 Devo collector features ] [ 4 Data sources ] [ 5 Flattening preprocessing ] [ 6 Vendor setup ] [ 7 Minimum configuration required for basic pulling ] [ 8 Accepted authentication methods ] [ 9 Run the collector ] [ 10 Collector services detail ] [ 11 Collector operations ] [ 12 Change log for v1.x.x ]

Configuration requirements

To run this collector, there are some configurations detailed below that you need to consider.

Configuration	Details

Configuration	Details
Access token	The access token is required to authenticate requests to the Akamai SIEM API.
Client secret	The client secret is required for secure authentication alongside the access token.
Client token	The client token is necessary for identifying and authenticating API requests.
Host	The host specifies the endpoint for the Akamai SIEM API.

Refer to the Vendor setup section to know more about these configurations.

Overview

The Akamai Event Viewer Collector is designed to retrieve and aggregate event data related to user activities and configuration changes from the Akamai platform. Leveraging Akamai's Event Viewer API, this collector enables seamless access to historical event logs, allowing organizations to centralize operational insights and track important system events. By integrating this data into external monitoring or analytics platforms, organizations can enhance their auditing capabilities, streamline troubleshooting, and maintain a comprehensive record of key actions performed within their infrastructure.

Devo collector features

Feature	Details

Feature	Details
Allow parallel downloading (`multipod`)	`not allowed`
Running environments	`collector server` `on-premise`
Populated Devo events	`table`
Flattening preprocessing	`no`

Data sources

Data Source	Description	API Endpoint	Collector Service Name	Devo Table	Available from release

Data Source	Description	API Endpoint	Collector Service Name	Devo Table	Available from release
Event Viewer events	Retrieves user activity and system configuration events. Paginated data ensures efficient retrieval and access to historical logs.	`/event-viewer-api/v1/events`	event_viewer_events	cdn.akamai.eventviewer	v1.0.0

For more information on how the events are parsed, visit our page

Flattening preprocessing

This collector does not implement flattening.

Vendor setup

Vendor Setup for Akamai Event Viewer

To configure the Akamai Event Viewer Service, follow these steps:

1. Access Akamai Control Center:

Log in to your Akamai Control Center using your credentials.
Navigate to the Event Viewer section in the main menu.

2. Assign the Required Role:

Go to the Identity and Access Management section.
Ensure your account is assigned the appropriate role for managing Event Viewer access.
For detailed role-based access configuration, refer to the Akamai Role-based Access Controls.

3. Create Authentication Credentials:

In the API Credentials section, generate new credentials.
Select the API service related to Event Viewer and set the access level to READ-WRITE.
Generate and securely store the following credentials:
- Client Token
- Client Secret
- Access Token
Detailed steps can be found in the Event Viewer API Guide.

4. Configure the Event Viewer API Endpoint:

Identify the correct hostname for the Event Viewer API endpoint.
Ensure that your connector or system is configured to communicate with this endpoint.

5. Implement EdgeGrid Authentication:

Ensure your connector supports Akamai EdgeGrid authentication.
Configure the connector with the Client Token, Client Secret, and Access Token obtained in the previous step.
For implementation details, refer to the Event Viewer API Documentation.

6. Enable Event Viewer Integration:

In the Akamai Control Center, navigate to the Event Viewer Integration section.
Enable data collection and configure the required settings for your environment.
For additional details, refer to the Akamai Event Viewer Documentation.

Minimum configuration required for basic pulling

Although this collector supports advanced configuration, the fields required to retrieve data with basic configuration are defined below.

This minimum configuration refers exclusively to those specific parameters of this integration. There are more required parameters related to the generic behavior of the collector. Check setting sections for details.

Setting	Details

Setting	Details
`access_token`	The access token is required to authenticate requests to the Akamai SIEM API.
`client_secret`	The client secret is required for secure authentication alongside the access token.
`client_token`	The client token is necessary for identifying and authenticating API requests.
`host`	The host specifies the endpoint for the Akamai SIEM API, typically in the format `{host}`.
`configs_id`	The configuration ID identifies the specific set of logs or security events to retrieve.

See the Accepted authentication methods section to verify what settings are required based on the desired authentication method.

Accepted authentication methods

EdgeGridAuth	Details

EdgeGridAuth	Details
`access_token`	The access token is required to authenticate requests to the Akamai SIEM API.
`client_secret`	The client secret is required for secure authentication alongside the access token.
`client_token`	The client token is necessary for identifying and authenticating API requests.

Run the collector

Once the data source is configured, you can either send us the required information if you want us to host and manage the collector for you (Cloud collector), or deploy and host the collector in your own machine using a Docker image (On-premise collector).

Collector services detail

This section is intended to explain how to proceed with specific actions for services.

Events service

Once the collector has been launched, it is important to check if the ingestion is performed in a proper way. To do so, go to the collector’s logs console.

This service has the following components:

Component	Description

Component	Description
Setup	The setup module is in charge of authenticating the service and managing the token expiration when needed.
Puller	The setup module is in charge of pulling the data in a organized way and delivering the events via SDK.

Setup output

A successful run has the following output messages for the setup module:

INFO InputProcess::MainThread -> AkamaiEventViewerPullerSetup(akamai-siem#12345,security_events#predefined) -> Starting thread
INFO InputProcess::MainThread -> AkamaiEventViewerPuller(akamai-siem#12345,security_events#predefined) - Starting thread
WARNING InputProcess::AkamaiEventViewerPullerSetup(akamai-siem#12345,security_events#predefined) -> The token/header/authentication has not been created yet
WARNING InputProcess::AkamaiEventViewerPuller(akamai-siem#12345,security_events#predefined) -> Waiting until setup will be executed
INFO InputProcess::MainThread -> InputMetricsThread -> Started thread for updating metrics values (update_period=10.0)
INFO InputProcess::AkamaiEventViewerPullerSetup(akamai-siem#12345,security_events#predefined) -> Building Akamai SIEM authentication...

Puller output

A successful initial run has the following output messages for the puller module:

InputProcess::AkamaiEventViewerPuller(akamai-siem#12345,event_viewer_events#predefined) -> AkamaiEventViewerPuller(akamai-siem#12345,event_viewer_events#predefined) Starting the execution of pre_pull()
InputProcess::AkamaiEventViewerPuller(akamai-siem#12345,event_viewer_events#predefined) -> Reading persisted data
InputProcess::AkamaiEventViewerPuller(akamai-siem#12345,event_viewer_events#predefined) -> Data retrieved from the persistence: None
InputProcess::AkamaiEventViewerPuller(akamai-siem#12345,event_viewer_events#predefined) -> Persistence will be overridden due to the retrieved state is empty
InputProcess::AkamaiEventViewerPuller(akamai-siem#12345,event_viewer_events#predefined) -> Running the persistence upgrade steps
InputProcess::AkamaiEventViewerPuller(akamai-siem#12345,event_viewer_events#predefined) -> Running the persistence corrections steps
InputProcess::AkamaiEventViewerPuller(akamai-siem#12345,event_viewer_events#predefined) -> Running the persistence corrections steps
InputProcess::AkamaiEventViewerPuller(akamai-siem#12345,event_viewer_events#predefined) -> Some changes have been detected and the persistence needs to be updated. Previous content: None. New content: {'@persistence_version': 1, 'configs_id': '15698', 'last_event_time_epoch': 1736875728, 'offset': 'NULL', 'last_ids': []}
InputProcess::AkamaiEventViewerPuller(akamai-siem#12345,event_viewer_events#predefined) -> Updating the persistence
InputProcess::AkamaiEventViewerPuller(akamai-siem#12345,event_viewer_events#predefined) -> Persistence has been updated successfully
InputProcess::AkamaiEventViewerPuller(akamai-siem#12345,event_viewer_events#predefined) -> AkamaiEventViewerPuller(akamai-siem#12345,event_viewer_events#predefined) Finalizing the execution of pre_pull()
InputProcess::AkamaiEventViewerPuller(akamai-siem#12345,event_viewer_events#predefined) -> Waiting 6.437 seconds before start pulling
InputProcess::AkamaiEventViewerPuller(akamai-siem#12345,event_viewer_events#predefined) -> Starting data collection every 60 seconds
InputProcess::AkamaiEventViewerPuller(akamai-siem#12345,event_viewer_events#predefined) -> Pull Started
InputProcess::AkamaiEventViewerPuller(akamai-siem#12345,event_viewer_events#predefined) -> Offset is invalid or expired. Using time-based mode with from=1736875728 and limit=10000.
InputProcess::AkamaiEventViewerPuller(akamai-siem#12345,event_viewer_events#predefined) -> Request report: 10012 events retrieved with 81053591 bytes. Sent them to Devo with tag: cdn.akamai.siem.
InputProcess::AkamaiEventViewerPuller(akamai-siem#12345,event_viewer_events#predefined) -> Stopping collection as there are no more events to process.
InputProcess::AkamaiEventViewerPuller(akamai-siem#12345,event_viewer_events#predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1736879340000):Number of requests made: 1; Number of events received: 10012; Number of duplicated events filtered out: 0; Number of events generated and sent: 10012; Average of events per second: 262.162.
InputProcess::AkamaiEventViewerPuller(akamai-siem#12345,event_viewer_events#predefined) -> Statistics for this pull cycle (@devo_pulling_id=1736879340000):Number of requests made: 1; Number of events received: 10012; Number of duplicated events filtered out: 0; Number of events generated and sent: 10012; Average of events per second: 262.160.
InputProcess::AkamaiEventViewerPuller(akamai-siem#12345,event_viewer_events#predefined) -> The data is up to date!
InputProcess::AkamaiEventViewerPuller(akamai-siem#12345,event_viewer_events#predefined) -> Data collection completed. Elapsed time: 38.197 seconds. Waiting for 21.803 second(s) until the next one

After a successful collector’s execution (that is, no error logs found), you will see the following log message:

InputProcess::AkamaiEventViewerPuller(akamai-siem#12345,event_viewer_events#predefined) -> Statistics for this pull cycle (@devo_pulling_id=1736879340000):Number of requests made: 1; Number of events received: 10012; Number of duplicated events filtered out: 0; Number of events generated and sent: 10012; Average of events per second: 262.160.

This collector uses persistent storage to download events in an orderly fashion and avoid duplicates. In case you want to re-ingest historical data or recreate the persistence, you can restart the persistence of this collector by following these steps:

Edit the configuration file.
Change the value of the eventtype_id parameter to a different one.
Save the changes.
Restart the collector.

The collector will detect this change and will restart the persistence using the parameters of the configuration file or the default configuration in case it has not been provided.

This collector has different security layers that detect both an invalid configuration and abnormal operation. This table will help you detect and resolve the most common errors.

Error Type	Error ID	Error Message	Cause	Solution

Error Type	Error ID	Error Message	Cause	Solution
InitVariablesError	22	"override_base_url" is invalid	The "override_base_url" variable is missing or not a string.	Ensure the "override_base_url" parameter is properly configured in `config.yaml`.
InitVariablesError	24	"logs_limit" setting not found	The "logs_limit" parameter is missing from the configuration.	Add the "logs_limit" setting in the `services` section of `config.yaml`.
InitVariablesError	26	"logs_limit" out of valid range	The "logs_limit" value must be between 1 and 600,000.	Update the "logs_limit" value in `config.yaml` to fall within the valid range.
InitVariablesError	29	"eventTypeId" setting not found	The "eventTypeId" parameter is missing in the configuration.	Add the "eventTypeId" setting in the `services` section of `config.yaml`.
InitVariablesError	30	"eventTypeId" is invalid	The "eventTypeId" is not a valid string.	Ensure that "eventTypeId" is a properly formatted string in `config.yaml`.
ApiError	401	HTTP 401 - Unauthorized	The API credentials (access token, client token, or client secret) are invalid.	Verify and update the API credentials in `config.yaml`.
ApiError	403	HTTP 403 - Forbidden	The API key lacks the required permissions to access the endpoint.	Ensure your credentials have the necessary permissions in Akamai Control Center.
ApiError	429	HTTP 429 - Too Many Requests	The rate limit for API requests has been exceeded.	Reduce the frequency of API requests and respect rate limit guidelines.
ApiError	500	HTTP 500 - Internal Server Error	Server-side issue in the Akamai Event Viewer API.	Retry the request later. If the problem persists, contact Akamai Support.
PersistenceError	404	Offset expired	The offset used for pulling data has expired due to inactivity or configuration changes.	Reset the persistence state and start a new pull operation.
BaseModelError	N/A	Session could not be initialized	Incorrect or missing authentication credentials.	Verify all credentials in `config.yaml` and retry.

Collector operations

This section is intended to explain how to proceed with specific operations of this collector.

Initialization

The initialization module is in charge of setup and running the input (pulling logic) and output (delivering logic) services and validating the given configuration.

A successful run has the following output messages for the initializer module:

Events delivery and Devo ingestion

The event delivery module is in charge of receiving the events from the internal queues where all events are injected by the pullers and delivering them using the selected compatible delivery method.

A successful run has the following output messages for the initializer module:

Sender services

The Integrations Factory Collector SDK has 3 different senders services depending on the event type to delivery (internal, standard, and lookup). This collector uses the following Sender Services:

Sender services	Description

Sender services	Description
`internal_senders`	In charge of delivering internal metrics to Devo such as logging traces or metrics.
`standard_senders`	In charge of delivering pulled events to Devo.

Sender statistics

Each service displays its own performance statistics that allow checking how many events have been delivered to Devo by type:

Logging trace	Description

Logging trace

Description

Number of available senders: 1

Displays the number of concurrent senders available for the given Sender Service.

sender manager internal queue size: 0

Displays the items available in the internal sender queue.

Total number of messages sent: 44, messages sent since "2022-06-28 10:39:22.511671+00:00": 21 (elapsed 0.007 seconds)

Displayes the number of events from the last time and following the given example, the following conclusions can be obtained:

44 events were sent to Devo since the collector started.
The last checkpoint timestamp was 2022-06-28 10:39:22.511671+00:00.
21 events where sent to Devo between the last UTC checkpoint and now.
Those 21 events required 0.007 seconds to be delivered.

To check the memory usage of this collector, look for the following log records in the collector which are displayed every 5 minutes by default, always after running the memory-free process.

The used memory is displayed by running processes and the sum of both values will give the total used memory for the collector.
The global pressure of the available memory is displayed in the global value.
All metrics (Global, RSS, VMS) include the value before freeing and after previous -> after freeing memory

Change log for v1.x.x

Release	Released on	Release type	Details	Recommendations

Release	Released on	Release type	Details	Recommendations
v1.0.0	Jan 10, 2025	NEW FEATURE	The Akamai Event Viewer Collector aggregates and streams security event data from Akamai's platform for monitoring and analysis.	`Recommended version`