Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Overview

CyberArk Identity provides a secure platform for managing application access, endpoints, and your network infrastructure.

Devo collector features

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

Custom

An existing event type source

/Redrock/query

An existing event type service

iam.cyberark.identity.{event_type}

v1.1.1

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

Flattening preprocessing

Data source

Collector service

Optional

Flattening details

Custom

An existing event type service

no

not required

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

tenant

The Tenant_id for cyberark identity.

client_id

The Client_Id for cyberark identity .

client_secret

The Client_secret for cyberark identity.

app_id

The App_id for cyberark idenity.

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

Accepted authentication methods

Authentication method

tenant

client_id

client_secret

app_id

credentials

REQUIRED

REQUIRED

REQUIRED

REQUIRED

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.

Custom_Service (must be an existing event type service)

 Verify data collection

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

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:

DevoSenderManager(standard_senders,manager,devo_1) -> Starting thread
2024-03-18T15:54:44.272    INFO OutputProcess::MainThread -> DevoSender(lookup_senders,devo_sender_0) -> Starting thread
2024-03-18T15:54:44.272    INFO OutputProcess::DevoSenderManager(standard_senders,manager,devo_1) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(standard_senders,manager,devo_1) -> Nothing retrieved from the persistence.
2024-03-18T15:54:44.272    INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(lookup_senders,devo_1) -> Starting thread (every 300 seconds)
2024-03-18T15:54:44.272    INFO OutputProcess::OutputStandardConsumer(standard_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputStandardConsumer(standard_senders_consumer_0) -> Nothing retrieved from the persistence.
2024-03-18T15:54:44.273    INFO OutputProcess::MainThread -> DevoSenderManager(lookup_senders,manager,devo_1) -> Starting thread
2024-03-18T15:54:44.273    INFO OutputProcess::DevoSenderManager(lookup_senders,manager,devo_1) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(lookup_senders,manager,devo_1) -> Nothing retrieved from the persistence.
2024-03-18T15:54:44.274    INFO OutputProcess::MainThread -> DevoSender(internal_senders,devo_sender_0) -> Starting thread
2024-03-18T15:54:44.274    INFO OutputProcess::OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputLookupConsumer(lookup_senders_consumer_0) -> Nothing retrieved from the persistence.
2024-03-18T15:54:44.274    INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(internal_senders,devo_1) -> Starting thread (every 300 seconds)
2024-03-18T15:54:44.274    INFO OutputProcess::MainThread -> DevoSenderManager(internal_senders,manager,devo_1) -> Starting thread
2024-03-18T15:54:44.275    INFO OutputProcess::DevoSenderManager(internal_senders,manager,devo_1) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(internal_senders,manager,devo_1) -> Nothing retrieved from the persistence.
2024-03-18T15:54:44.276    INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputInternalConsumer(internal_senders_consumer_0) -> Nothing retrieved from the persistence.
2024-03-18T15:54:44.288    INFO InputProcess::MainThread -> Validating common input config
2024-03-18T15:54:44.295    INFO InputProcess::MainThread -> Validating service input config
2024-03-18T15:54:44.297    INFO OutputProcess::MainThread -> [GC] global: 55.1% -> 55.1%, process: RSS(55.61MiB -> 55.73MiB), VMS(1.21GiB -> 1.21GiB)
2024-03-18T15:54:44.299    INFO InputProcess::MainThread -> Running overriding rules
2024-03-18T15:54:44.299    INFO InputProcess::MainThread -> Overriding rule #1 - service key <override_tag> with value <my.app.cyberark.cloud_launch> overrides definition key <tag> with value <None> when the first is not <None>
2024-03-18T15:54:44.300    INFO InputProcess::MainThread -> Validating the rate limiter config given by the user
2024-03-18T15:54:44.300    INFO InputProcess::MainThread -> <requests_limits> setting has not been defined. The generic settings will be used instead.
2024-03-18T15:54:44.300    INFO InputProcess::MainThread -> Adding raw config to the collector store
2024-03-18T15:54:44.300    INFO InputProcess::MainThread -> Running custom validation rules
2024-03-18T15:54:44.300    INFO InputProcess::MainThread -> CyberArkIdentityPuller(cyberark_identity,100001,Cloud.Saas.Application.AppLaunch,custom) Finalizing the execution of init_variables()
2024-03-18T15:54:44.303    INFO InputProcess::MainThread -> InputThread(cyberark_identity,100001) - Starting thread (execution_period=60s)
2024-03-18T15:54:44.303    INFO InputProcess::MainThread -> ServiceThread(cyberark_identity,100001,Cloud.Saas.Application.AppLaunch,custom) - Starting thread (execution_period=60s)
2024-03-18T15:54:44.303    INFO InputProcess::MainThread -> CyberArkIdentityPullerSetup(example_collector,cyberark_identity#100001,Cloud.Saas.Application.AppLaunch#custom) -> Starting thread
2024-03-18T15:54:44.304 WARNING InputProcess::CyberArkIdentityPullerSetup(example_collector,cyberark_identity#100001,Cloud.Saas.Application.AppLaunch#custom) -> The token/header/authentication has not been created yet
2024-03-18T15:54:44.305    INFO InputProcess::MainThread -> CyberArkIdentityPuller(cyberark_identity,100001,Cloud.Saas.Application.AppLaunch,custom) - Starting thread
2024-03-18T15:54:44.305 WARNING InputProcess::CyberArkIdentityPuller(cyberark_identity,100001,Cloud.Saas.Application.AppLaunch,custom) -> Waiting until setup will be executed
2024-03-18T15:54:44.307    INFO InputProcess::CyberArkIdentityPullerSetup(example_collector,cyberark_identity#100001,Cloud.Saas.Application.AppLaunch#custom) -> Performing sample query to test data access: {'Script': "SELECT EventType,DirectoryServiceUuid,InternalTrackingId,WhenOccurred,RequestHostName,AzDeploymentId,EntityType,ApplicationType,Level,AzRoleId,NewEntity,ID,Tenant,AzRoleName,FromIPAddress,UserGuid,RequestDeviceOS,AuthMethod,OldEntity,DirectoryServicePartnerName,EntityUuid,ApplicationId,NormalizedUser,EntityName,ImpersonatorUuid,TemplateName,InternalSessionId,WhenLogged,RequestIsMobileDevice,ApplicationName,ThreadType FROM Events WHERE '2024-03-18T10:24:14.306488Z' <= WhenLogged AND WhenLogged < '2024-03-18T10:24:44.306488Z' AND EventType = 'Cloud.Saas.Application.AppLaunch' ORDER BY WhenLogged ASC", 'args': {'PageNumber': 1, 'PageSize': 1000, 'Caching': 0}}
2024-03-18T15:54:44.323    INFO InputProcess::MainThread -> [GC] global: 55.1% -> 55.1%, process: RSS(54.77MiB -> 54.77MiB), VMS(804.38MiB -> 804.38MiB)
2024-03-18T15:54:44.930    INFO OutputProcess::DevoSender(internal_senders,devo_sender_0) -> Created a sender: {"name": "DevoSender(internal_senders,devo_sender_0)", "url": "collector-eu.devo.io:443", "chain_path": "/home/mdtausif/Gitlab/devo-collector-cyberark-identity/certs/chain.crt", "cert_path": "/home/mdtausif/Gitlab/devo-collector-cyberark-identity/certs/int-if-integrations-india.crt", "key_path": "/home/mdtausif/Gitlab/devo-collector-cyberark-identity/certs/int-if-integrations-india.key", "transport_layer_type": "SSL", "last_usage_timestamp": null, "socket_status": null}, hostname: "2023-apac-0046", session_id: "131135409034480"
2024-03-18T15:54:46.713    INFO InputProcess::CyberArkIdentityPullerSetup(example_collector,cyberark_identity#100001,Cloud.Saas.Application.AppLaunch#custom) -> Setup for module <CyberArkIdentityPuller> has been successfully executed

Puller output

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

Note that the PrePull action is executed only one time before the first run of the Pull action.

2024-03-18T16:42:36.085    INFO InputProcess::CyberArkIdentityPuller(cyberark_identity,100001,Cloud.Saas.Application.AppLaunch,custom) -> Pull Started
2024-03-18T16:42:36.085    INFO InputProcess::CyberArkIdentityPuller(cyberark_identity,100001,Cloud.Saas.Application.AppLaunch,custom) -> Fetching Cloud.Saas.Application.AppLaunch records subject to following args: {'PageNumber': 1, 'PageSize': 1000, 'Caching': 0}
2024-03-18T16:42:36.085    INFO InputProcess::CyberArkIdentityPuller(cyberark_identity,100001,Cloud.Saas.Application.AppLaunch,custom) -> Fetching Cloud.Saas.Application.AppLaunch records subject to following query: SELECT WhenOccurred,ImpersonatorUuid,ApplicationType,FromIPAddress,EntityUuid,DirectoryServicePartnerName,AzRoleName,TemplateName,Tenant,ThreadType,EntityType,RequestHostName,AzRoleId,InternalTrackingId,ApplicationName,RequestDeviceOS,NormalizedUser,EntityName,ID,AuthMethod,UserGuid,OldEntity,Level,DirectoryServiceUuid,AzDeploymentId,EventType,RequestIsMobileDevice,NewEntity,ApplicationId,InternalSessionId,WhenLogged FROM Events WHERE '2020-01-01T00:00:00.000000Z' <= WhenLogged AND WhenLogged < '2024-03-18T11:12:31.077915+00:00' AND EventType = 'Cloud.Saas.Application.AppLaunch' ORDER BY WhenLogged ASC
2024-03-18T16:42:36.857    INFO InputProcess::CyberArkIdentityPuller(cyberark_identity,100001,Cloud.Saas.Application.AppLaunch,custom) -> Received 15 record(s)
2024-03-18T16:42:36.860    INFO InputProcess::CyberArkIdentityPuller(cyberark_identity,100001,Cloud.Saas.Application.AppLaunch,custom) -> Sending 15 record(s) to tag 'my.app.cyberark.cloud_launch'
2024-03-18T16:42:36.862    INFO InputProcess::CyberArkIdentityPuller(cyberark_identity,100001,Cloud.Saas.Application.AppLaunch,custom) -> No more records available. Setting pull_completed to True.
2024-03-18T16:42:36.864    INFO InputProcess::CyberArkIdentityPuller(cyberark_identity,100001,Cloud.Saas.Application.AppLaunch,custom) -> Updating the persistence
2024-03-18T16:42:36.864    INFO InputProcess::CyberArkIdentityPuller(cyberark_identity,100001,Cloud.Saas.Application.AppLaunch,custom) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1710760356077):Number of requests made: 1; Number of events received: 15; Number of duplicated events filtered out: 0; Number of events generated and sent: 15; Average of events per second: 19.242.

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

2024-03-18T16:42:36.864    INFO InputProcess::CyberArkIdentityPuller(cyberark_identity,100001,Cloud.Saas.Application.AppLaunch,custom) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1710760356077):Number of requests made: 1; Number of events received: 15; Number of duplicated events filtered out: 0; Number of events generated and sent: 15; Average of events per second: 19.242.

The value @devo_pulling_id is injected in each event to group all events ingested by the same pull action. You can use it to get the exact events downloaded in that Pull action in Devo’s search window.

 Restart the persistence

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:

  1. Edit the configuration file.

  2. Change the value of the start_time_in_utc parameter to a different one.

  3. Save the changes.

  4. 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.

Note that this action clears the persistence and cannot be recovered in any way. Resetting persistence could result in duplicate or lost events.

 Troubleshooting

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

SetupError

499

Error occurred while Making request from Cyberark Redrock API

 

Error Details will provided in this case

Contact team in this case

PullError

495

Value Error occurred because parsing the response failed to the required format

This error happens when the collector tries to parse the response to the provided 

In this error you will find the Value error code and content it is being parsed to as well as 

496

Connection Timeout Error occurred while retrieving events from Cyberark server : {Exception}

Connection timeout exceptions occurred while making the API request.

Please check if endpoint and URL parameter are correct.

497

Retry Exceptions  

Retry exceptions. We get reason for the exceptions occurred

Please contact developer if this error occurs

498

Max retries error. It provides the reason for this error.

Reason is provided for getting such error

Please contact developer if this error occurs

Collector operations

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

 Verify collector operations

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:

2024-03-18T15:54:44.046    INFO MainProcess::MainThread -> Initialized all object from "MainProcess" process
2024-03-18T15:54:44.046    INFO MainProcess::MainThread -> OutputProcess - Starting thread (executing_period=120s)
2024-03-18T15:54:44.049    INFO MainProcess::MainThread -> InputProcess - Starting thread (executing_period=120s)
2024-03-18T15:54:44.054    INFO MainProcess::MainThread -> Started all object from "MainProcess" process
2024-03-18T15:54:44.153    INFO OutputProcess::MainThread -> Process started
2024-03-18T15:54:44.157    INFO InputProcess::MainThread -> Process Started
2024-03-18T15:54:44.261    INFO InputProcess::MainThread -> CyberArkIdentityPuller(cyberark_identity,100001,Cloud.Saas.Application.AppLaunch,custom) Starting the execution of init_variables()
2024-03-18T15:54:44.261    INFO InputProcess::MainThread -> Validating service metadata
2024-03-18T15:54:44.267    INFO InputProcess::MainThread -> Validating defined module definition
2024-03-18T15:54:44.270    INFO OutputProcess::MainThread -> DevoSender(standard_senders,devo_sender_0) -> Starting thread
2024-03-18T15:54:44.271    INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(standard_senders,devo_1) -> Starting thread (every 300 seconds)
2024-03-18T15:54:44.271    INFO OutputProcess::MainThread -> DevoSenderManager(standard_senders,manager,devo_1) -> Starting thread
2024-03-18T15:54:44.272    INFO OutputProcess::MainThread -> DevoSender(lookup_senders,devo_sender_0) -> Starting thread
2024-03-18T15:54:44.272    INFO OutputProcess::DevoSenderManager(standard_senders,manager,devo_1) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(standard_senders,manager,devo_1) -> Nothing retrieved from the persistence.
2024-03-18T15:54:44.272    INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(lookup_senders,devo_1) -> Starting thread (every 300 seconds)
2024-03-18T15:54:44.272    INFO OutputProcess::OutputStandardConsumer(standard_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputStandardConsumer(standard_senders_consumer_0) -> Nothing retrieved from the persistence.
2024-03-18T15:54:44.273    INFO OutputProcess::MainThread -> DevoSenderManager(lookup_senders,manager,devo_1) -> Starting thread
2024-03-18T15:54:44.273    INFO OutputProcess::DevoSenderManager(lookup_senders,manager,devo_1) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(lookup_senders,manager,devo_1) -> Nothing retrieved from the persistence.
2024-03-18T15:54:44.274    INFO OutputProcess::MainThread -> DevoSender(internal_senders,devo_sender_0) -> Starting thread
2024-03-18T15:54:44.274    INFO OutputProcess::OutputLookupConsumer(lookup_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputLookupConsumer(lookup_senders_consumer_0) -> Nothing retrieved from the persistence.
2024-03-18T15:54:44.274    INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(internal_senders,devo_1) -> Starting thread (every 300 seconds)
2024-03-18T15:54:44.274    INFO OutputProcess::MainThread -> DevoSenderManager(internal_senders,manager,devo_1) -> Starting thread
2024-03-18T15:54:44.275    INFO OutputProcess::DevoSenderManager(internal_senders,manager,devo_1) -> [EMERGENCY PERSISTENCE SYSTEM] DevoSenderManager(internal_senders,manager,devo_1) -> Nothing retrieved from the persistence.
2024-03-18T15:54:44.276    INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> [EMERGENCY PERSISTENCE SYSTEM] OutputInternalConsumer(internal_senders_consumer_0) -> Nothing retrieved from the persistence.
2024-03-18T15:54:44.288    INFO InputProcess::MainThread -> Validating common input config
2024-03-18T15:54:44.295    INFO InputProcess::MainThread -> Validating service input config
2024-03-18T15:54:44.297    INFO OutputProcess::MainThread -> [GC] global: 55.1% -> 55.1%, process: RSS(55.61MiB -> 55.73MiB), VMS(1.21GiB -> 1.21GiB)
2024-03-18T15:54:44.299    INFO InputProcess::MainThread -> Running overriding rules
2024-03-18T15:54:44.299    INFO InputProcess::MainThread -> Overriding rule #1 - service key <override_tag> with value <my.app.cyberark.cloud_launch> overrides definition key <tag> with value <None> when the first is not <None>
2024-03-18T15:54:44.300    INFO InputProcess::MainThread -> Validating the rate limiter config given by the user
2024-03-18T15:54:44.300    INFO InputProcess::MainThread -> <requests_limits> setting has not been defined. The generic settings will be used instead.
2024-03-18T15:54:44.300    INFO InputProcess::MainThread -> Adding raw config to the collector store
2024-03-18T15:54:44.300    INFO InputProcess::MainThread -> Running custom validation rules
2024-03-18T15:54:44.300    INFO InputProcess::MainThread -> CyberArkIdentityPuller(cyberark_identity,100001,Cloud.Saas.Application.AppLaunch,custom) Finalizing the execution of init_variables()

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:

2024-03-18T16:47:33.072    INFO OutputProcess::DevoSenderManagerMonitor(internal_senders,devo_1) -> Number of available senders: 1, sender manager internal queue size: 0
2024-03-18T16:47:33.073    INFO OutputProcess::DevoSenderManagerMonitor(internal_senders,devo_1) -> enqueued_elapsed_times_in_seconds_stats: {}
2024-03-18T16:47:33.073    INFO OutputProcess::DevoSenderManagerMonitor(internal_senders,devo_1) -> Sender: DevoSender(internal_senders,devo_sender_0), status: {"internal_queue_size": 0, "is_connection_open": True}
2024-03-18T16:47:33.073    INFO OutputProcess::DevoSenderManagerMonitor(internal_senders,devo_1) -> Internal - Total number of messages: 48 messages/bytes sent since/to "2024-03-18T11:12:33.069163+00:00/2024-03-18T11:17:33.073184+00:00": 48/22779, (elapsed 0.424 seconds)
2024-03-18T16:47:33.083    INFO InputProcess::InputStatsThread -> Input metrics sent: 3
2024-03-18T16:47:33.084    INFO OutputProcess::OutputInternalConsumer(internal_senders_consumer_0) -> Consumed messages: 3, total_bytes: 2581 (60.000418 seconds)

By default, these information traces will be displayed every 10 minutes.

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

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

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.

This value helps detect bottlenecks and needs to increase the performance of data delivery to Devo. This last can be made by increasing the concurrent senders.

2024-03-18T12:05:03.479    INFO OutputProcess::DevoSenderManagerMonitor(lookup_senders,devo_us_1) -> Lookup - Total number of messages sent: 0, messages sent since "2024-02-16 06:30:03.476741+00:00": 0 (elapsed 0.000 seconds)

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

  • 0 events were sent to Devo since the collector started.

  • The last checkpoint timestamp was 2024-02-16 06:30:03.476741+00:00..

  • Those messages required 0 seconds to be delivered.

By default these traces will be shown every 10 minutes.

 Check memory usage

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

2024-03-18T16:48:33.129    INFO OutputProcess::MainThread -> [GC] global: 53.8% -> 53.8%, process: RSS(47.24MiB -> 47.24MiB), VMS(935.70MiB -> 935.70MiB)
2024-03-18T16:49:33.152    INFO InputProcess::MainThread -> [GC] global: 53.6% -> 53.6%, process: RSS(56.27MiB -> 56.27MiB), VMS(581.19MiB -> 581.19MiB)

Differences between RSS and VMS memory usage:

  • RSS is the Resident Set Size, which is the actual physical memory the process is using

  • VMS is the Virtual Memory Size which is the virtual memory that process is using

Change log

Release

Released on

Release type

Details

Recommendations

v1.1.2

FIRST RELEASE

Released the first version of the Cyberark Identity collector.

Recommended version

  • No labels