Document toolboxDocument toolbox

IBM Softlayer collector

Overview

The IBM Softlayer (IBM Cloud) platform combines platform as a service (PaaS) with infrastructure as a service (IaaS) to provide an integrated experience. The platform scales and supports both small development teams and organizations and large enterprise businesses.

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

Allowed source events obfuscation

yes

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

SoftLayer_Event_Log

Event Log service lets you find interesting events related to various SoftLayer products and services such as hardware, virtual server, or DNS.

/SoftLayer_Event_Log/getAllObjects

 

event_log

cloud.ibm.softlayer.event_log

v1.0.0

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

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

username

The SoftLayer username

api_key

The SoftLayer API key

Accepted authentication methods

Authentication method

Username

API key

Username/API key

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.

Events service

Internal process and deduplication method

All events are fetched via the /SoftLayer_Event_Log/getAllObjects endpoint and filtered / ordered by the eventCreateDate value. The collector continually pulls new events since the last recorded timestamp. A unique hash value is computed for each event and used for deduplication purposes to ensure events are not fetched multiple times in subsequent pulls.

Devo categorization and destination

All events of this service are ingested into the table cloud.ibm.softlayer.event_log.

Setup output

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

2023-09-02T14:31:19.290 INFO InputProcess::MainThread -> AdvSearchPullerSetup(unknown,ibm_softlayer#10001,event_log#predefined) -> Starting thread 2023-09-02T14:31:19.291 WARNING InputProcess::AdvSearchPuller(ibm_softlayer,10001,event_log,predefined) -> Waiting until setup will be executed 2023-09-02T14:31:19.291 WARNING InputProcess::AdvSearchPullerSetup(unknown,ibm_softlayer#10001,event_log#predefined) -> The token/header/authentication has not been created yet 2023-09-02T14:31:19.308 INFO InputProcess::AdvSearchPullerSetup(unknown,ibm_softlayer#10001,event_log#predefined) -> Testing fetch from /rest/v3.1/SoftLayer_Search/advancedSearch.json. 2023-09-02T14:31:20.196 INFO InputProcess::AdvSearchPullerSetup(unknown,ibm_softlayer#10001,event_log#predefined) -> Successfully tested fetch from /rest/v3.1/SoftLayer_Search/advancedSearch.json. Source is pullable. 2023-09-02T14:31:20.197 INFO InputProcess::AdvSearchPullerSetup(unknown,ibm_softlayer#10001,event_log#predefined) -> Setup for module <AdvSearchPuller> has been successfully executed

Puller output

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

2023-09-02T14:31:20.293 INFO InputProcess::AdvSearchPuller(ibm_softlayer,10001,event_log,predefined) -> AdvSearchPuller(ibm_softlayer,10001,event_log,predefined) Starting the execution of pre_pull() 2023-09-02T14:31:20.294 INFO InputProcess::AdvSearchPuller(ibm_softlayer,10001,event_log,predefined) -> Reading persisted data 2023-09-02T14:31:20.294 INFO InputProcess::AdvSearchPuller(ibm_softlayer,10001,event_log,predefined) -> Data retrieved from the persistence: {'@persistence_version': 1, 'start_time_in_utc': '2019-09-01T16:05:49+00:00', 'last_event_time_in_utc': '2023-09-02T17:52:24+00:00', 'last_ids': ['0b2f5b168836a74c81d4fdb17c1d8a1b6e5a0aeccb837fe2d717f260e46de9bf'], 'next_offset': 0, 'next_search_str': None} 2023-09-02T14:31:20.295 INFO InputProcess::AdvSearchPuller(ibm_softlayer,10001,event_log,predefined) -> Running the persistence upgrade steps 2023-09-02T14:31:20.295 INFO InputProcess::AdvSearchPuller(ibm_softlayer,10001,event_log,predefined) -> Running the persistence corrections steps 2023-09-02T14:31:20.295 INFO InputProcess::AdvSearchPuller(ibm_softlayer,10001,event_log,predefined) -> Running the persistence corrections steps 2023-09-02T14:31:20.296 INFO InputProcess::AdvSearchPuller(ibm_softlayer,10001,event_log,predefined) -> No changes were detected in the persistence 2023-09-02T14:31:20.296 INFO InputProcess::AdvSearchPuller(ibm_softlayer,10001,event_log,predefined) -> AdvSearchPuller(ibm_softlayer,10001,event_log,predefined) Finalizing the execution of pre_pull() 2023-09-02T14:31:20.296 INFO InputProcess::AdvSearchPuller(ibm_softlayer,10001,event_log,predefined) -> Starting data collection every 60 seconds 2023-09-02T14:31:20.297 INFO InputProcess::AdvSearchPuller(ibm_softlayer,10001,event_log,predefined) -> Pull Started 2023-09-02T14:31:20.297 INFO InputProcess::AdvSearchPuller(ibm_softlayer,10001,event_log,predefined) -> Fetching event_log records from 2023-09-02T17:52:24+00:00 to 2023-09-02 18:31:20.293760+00:00 (offset=0, limit=50) 2023-09-02T14:31:21.271 INFO InputProcess::AdvSearchPuller(ibm_softlayer,10001,event_log,predefined) -> No more records available. Setting pull_completed to True. 2023-09-02T14:31:21.280 INFO InputProcess::AdvSearchPuller(ibm_softlayer,10001,event_log,predefined) -> Updating the persistence 2023-09-02T14:31:21.281 INFO InputProcess::AdvSearchPuller(ibm_softlayer,10001,event_log,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1693679480293):Number of requests made: 1; Number of events received: 1; Number of duplicated events filtered out: 1; Number of events generated and sent: 0; Average of events per second: 0.000. 2023-09-02T14:31:21.281 INFO InputProcess::AdvSearchPuller(ibm_softlayer,10001,event_log,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1693679480293):Number of requests made: 1; Number of events received: 1; Number of duplicated events filtered out: 1; Number of events generated and sent: 0; Average of events per second: 0.000.

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

2023-09-02T14:31:21.282 INFO InputProcess::AdvSearchPuller(ibm_softlayer,10001,event_log,predefined) -> The data is up to date! 2023-09-02T14:31:21.282 INFO InputProcess::AdvSearchPuller(ibm_softlayer,10001,event_log,predefined) -> Data collection completed. Elapsed time: 0.989 seconds. Waiting for 59.011 second(s) until the next one

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.

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

InitVariablesError

1

Invalid start_time_in_utc: {ini_start_str}. Must be in parseable datetime format.

The configured start_time_in_utc parameter is a non-parseable format.

Update the start_time_in_utc value to have the recommended format as indicated in the guide.

InitVariablesError

2

Invalid start_time_in_utc: {ini_start_str}. Must be in the past.

The configured start_time_in_utc parameter is a future date.

Update the start_time_in_utc value to a past datetime.

SetupError

101

Failed to fetch OAuth token from {token_endpoint}. Exception: {e}.

The provided credentials, base URL, and/or token endpoint is incorrect.

Revisit the configuration steps and ensure that the correct values were specified in the config file.

SetupError

102

Failed to fetch data from {endpoint}. Source is not pullable.

The provided credentials, base URL, and/or token endpoint is incorrect.

Revisit the configuration steps and ensure that the correct values were specified in the config file.

ApiError

401

Error during API call to [API provider HTML error response here]

The server returned an HTTP 401 response.

Ensure that the provided credentials are correct and provide read access to the targeted data.

ApiError

429

Error during API call to [API provider HTML error response here]

The server returned an HTTP 429 response.

The collector will attempt to retry requests (default up to 3 times) and respect back-off headers if they exist. If the collector repeatedly encounters this error, adjust the rate limit and/or contact the API provider to ensure that you have enough quota to complete the data pull.

ApiError

498

Error during API call to [API provider HTML error response here]

The server returned an HTTP 500 response.

If the API returns a 500 but successfully completes subsequent runs then you may ignore this error. If the API repeatedly returns a 500 error, ensure the server is reachable and operational.

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.

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.

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.

By default these traces will be shown every 10 minutes.

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

Release

Released on

Release type

Details

Recommendations

Release

Released on

Release type

Details

Recommendations

v1.0.0

Nov 14, 2023

INITIAL RELEASE



New features:

  • Event Log service lets you find interesting events related to various SoftLayer products and services such as hardware, virtual server, or DNS.

Released with v1.10.2

Recommended version