---
title: "Lastpass collector"
canonical: "https://docs.devo.com/space/latest/424378646/Lastpass%20collector"
format: markdown
---
> Macro (toc)

## Overview

LastPass is a password manager that makes it easy to log in to any website or app. The Devo Collector for LastPass fetches all reporting events so that users can track user and platform activity.

## Devo collector features

| **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** |
| --- | --- | --- | --- | --- | --- |
| reporting | Fetches all LastPass reporting events | `lastpass.com/enterpriseapi.php` | reporting | `app.lastpass.events` | `v1.0.0` |

For more information on how the events are parsed, [visit our page](https://devodocs.atlassian.net/wiki/spaces/latest/pages/311361689).

## 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** |
| --- | --- |
| `company_id` | The company ID is the account number listed on the <u>[Admin Dashboard page.](https://admin.lastpass.com/dashboard)</u> |
| `provisioning_hash` | The provisioning hash is the master API key that can be set from the <u>[Admin Enterprise API page.](https://admin.lastpass.com/advanced/enterpriseApi)</u> |

## Accepted authentication methods

|  |  |  |
| --- | --- | --- |
| **Authentication method** | **Company ID** | **Provisioning hash** |
| `company_id/provisioning_hash` | 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 (<u>Cloud collector</u>), or deploy and host the collector in your own machine using a Docker image (<u>On-premise collector</u>).

> Macro (rw-ui-tabs-macro)
> 
> > Macro (rw-tab)
> 
> We use a piece of software called Collector Server to host and manage all our available collectors. If you want us to host this collector for you, [get in touch with us](https://devo.my.site.com/support/login?ec=302&startURL=%2Fsupport%2Fs%2F) and we will guide you through the configuration.
> 
> > Macro (rw-tab)
> 
> This data collector can be run in any machine that has the Docker service available because it should be executed as a docker container. The following sections explain how to prepare all the required setup for having the data collector running.
> 
> ### Structure
> 
> The following directory structure should be created for being used when running the collector:
> 
> ```
> <any_directory>
> └── devo-collectors/
>     └── <product_name>/
>         ├── certs/
>         │   ├── chain.crt
>         │   ├── <your_domain>.key
>         │   └── <your_domain>.crt
>         ├── state/
>         └── config/ 
>             └── config.yaml 
> ```
> 
> > ⚠️ Replace `<product_name>` with the proper value.
> 
> ### Devo credentials
> 
> In Devo, go to **Administration → Credentials → X.509 Certificates**, download the **Certificate**, **Private key** and **Chain CA** and save them in `<product_name>/certs/`. Learn more about security credentials in Devo [here](#).
> 
> ![image](media://4a7fcf39-d762-4272-9fcd-a820608b9d3d)
> 
> > ⚠️ Replace `<product_name>` with the proper value.
> 
> ### Editing the config.yaml file
> 
> ```
> globals:
>   debug: false
>   id: <collector_id>
>   name: <collector_name>
>   persistence:
>     type: filesystem
>     config:
>       directory_name: state
> outputs:
>   devo_us_1:
>     type: devo_platform
>     config:
>       address: <devo_address>
>       port: 443
>       type: SSL
>       chain: <chain_filename>
>       cert: <cert_filename>
>       key: <key_filename>
> 
> inputs:
>   lastpass:
>     id: <input_id_value>
>     enabled: true
>     credentials:
>       company_id: <company_id_value>
>       provisioning_hash: <provisioning_hash_value>
>     services:
>       reporting:
>         override_tag: <override_tag_value>
>         start_time_in_utc: <start_time_in_utc_value>
>         obfuscation_data: [<obfuscation_data_values>]
> ```
> 
> > ℹ️ All defined service entities will be executed by the collector. If you do not want to run any of them, just remove the entity from the `services` object.
> 
> Replace the placeholders with your required values following the description table below:
> 
> |  |  |  |  |  |
> | --- | --- | --- | --- | --- |
> | Parameter | Data type | Type | Value Range / Format | Details |
> | `collector_id` | str | mandatory | `TODO` |  |
> | `collector_name` | str | mandatory | `TODO` |  |
> | `devo_address` | str | mandatory | `collector-us.devo.io `<br>`collector-eu.devo.io` | Use this parameter to identify the Devo Cloud where the events will be sent. |
> | `chain_filename` | str | mandatory | minimum length: 4<br>maximum length: 20 | Use this parameter to identify the chain.cert file downloaded from your Devo domain. Usually this file's name is: `chain.crt`. |
> | `cert_filename` | str | mandatory | minimum length: 4<br>maximum length: 20 | Use this parameter to identify the file.cert downloaded from your Devo domain. |
> | `key_filename` | str | mandatory | minimum length: 4<br>maximum length: 20 | Use this parameter to identify the file.key downloaded from your Devo domain. |
> | `input_id_value` | int | mandatory | minimum length: 5<br>maximum length: 15 | Use this parameter to give a unique ID to this input service.<br>> ⚠️ This parameter is used to build the persistence address. Do not use the same value for multiple collectors. It could cause a collision. |
> | `company_id_value` | str/int | mandatory | Minimum length: 1 | The company ID is the account number listed on the <u>[Admin Dashboard page.](https://admin.lastpass.com/dashboard)</u> |
> | `provisioning_hash_value` | str | mandatory | Minimum length: 1 | The provisioning hash is the master API key that can be set from the <u>[Admin Enterprise API page.](https://admin.lastpass.com/advanced/enterpriseApi)</u> |
> | `override_tag_value` | str | optional | Devo tag-friendly string (no special characters, spaces, etc.) For more information see <u>[Devo Tags](https://docs.devo.com/space/latest/95126204/About%20Devo%20tags)</u>. | An optional tag that allows users to override the service default tags.<br>> ℹ️ This parameter can be removed or commented. |
> | `start_time_in_utc_value` | str | optional | UTC datetime string having datetime string format `%-Y-%m-%d %H-%M-%S` (e.g., “`2000-01-01 00:00:01`”) | This configuration allows you to set a custom date as the beginning of the period to download. This allows downloading historical data (one month back for example) before downloading new events.<br>> ℹ️ This parameter should be removed if it is not used. |
> | `obfuscation_data_values` | array<object> | optional | The objects in the array look like this:<br>```
> obfuscation_data:
>   - name:
>       - credentials
>       - "*"
>     value: "**********"
> ``` | Each object represents the necessary configuration to obfuscate messages before these are sent to Devo.<br>> ℹ️ This parameter can be removed or commented. |
> 
> ### Download the Docker image
> 
> The collector should be deployed as a Docker container. Download the Docker image of the collector as a .tgz file by clicking the link in the following table:
> 
> | **Collector Docker image** | **SHA-256 hash** |
> | --- | --- |
> | [collector-lastpass_collector_if-docker-image-1.0.0.tgz](https://drive.google.com/file/d/1DaTpedYuJu55XkYgdV4N9mBCRIV4ufF4/view?usp=drive_link) | `a68682065ba8062638d12542b54a29ce0aca8a09a6371a6085800f07e1f03f30` |
> 
> Use the following command to add the Docker image to the system:
> 
> ```
> gunzip -c <image_file>-<version>.tgz | docker load
> ```
> 
> > ⚠️ Once the Docker image is imported, it will show the real name of the Docker image (including version info). Replace `<image_file>` and `<version>` with a proper value.
> 
> The Docker image can be deployed on the following services:
> 
> #### Docker
> 
> Execute the following command on the root directory `<any_directory>/devo-collectors/<product_name>/`
> 
> ```
> docker run 
> --name collector-<product_name> 
> --volume $PWD/certs:/devo-collector/certs 
> --volume $PWD/config:/devo-collector/config 
> --volume $PWD/state:/devo-collector/state 
> --env CONFIG_FILE=config.yaml 
> --rm 
> --interactive 
> --tty 
> <image_name>:<version>
> ```
> 
> > ⚠️ Replace `<product_name>`, `<image_name>` and `<version>` with the proper values.
> 
> #### Docker Compose
> 
> The following Docker Compose file can be used to execute the Docker container. It must be created in the `<any_directory>/devo-collectors/<product_name>/` directory.
> 
> ```
> version: '3'
> services:
>   collector-<product_name>:
>     image: <image_name>:${IMAGE_VERSION:-latest}
>     container_name: collector-<product_name>
>     volumes:
>       - ./certs:/devo-collector/certs
>       - ./config:/devo-collector/config
>       - ./credentials:/devo-collector/credentials
>       - ./state:/devo-collector/state
>     environment:
>       - CONFIG_FILE=${CONFIG_FILE:-config.yaml}
> ```
> 
> To run the container using docker-compose, execute the following command from the `<any_directory>/devo-collectors/<product_name>/` directory:
> 
> ```
> IMAGE_VERSION=<version> docker-compose up -d
> ```
> 
> > ⚠️ Replace `<product_name>`, `<image_name>` and `<version>` with the proper values.

## Collector services detail

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

### Events service

<details>
<summary>reporting</summary>

#### Internal process and deduplication method

All LastPass reporting events are fetched via the `reporting` command endpoint. 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 `app.lastpass.events`

#### Setup output

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

```
2023-07-29T20:42:42.391    INFO InputProcess::MainThread -> LastPassPullerSetup(unknown,lastpass#10001,reporting#predefined) -> Starting thread
2023-07-29T20:42:42.392    INFO InputProcess::MainThread -> LastPassPuller(lastpass,10001,reporting,predefined) - Starting thread
2023-07-29T20:42:43.632    INFO InputProcess::LastPassPullerSetup(unknown,lastpass#10001,reporting#predefined) -> Successfully tested fetch data for cmd reporting. Source is pullable.
2023-07-29T20:42:43.633    INFO InputProcess::LastPassPullerSetup(unknown,lastpass#10001,reporting#predefined) -> Setup for module <LastPassPuller> has been successfully executed
```

#### Puller output

```
2023-07-29T20:42:44.399    INFO InputProcess::LastPassPuller(lastpass,10001,reporting,predefined) -> LastPassPuller(lastpass,10001,reporting,predefined) Starting the execution of pre_pull()
2023-07-29T20:42:44.399    INFO InputProcess::LastPassPuller(lastpass,10001,reporting,predefined) -> Reading persisted data
2023-07-29T20:42:44.400    INFO InputProcess::LastPassPuller(lastpass,10001,reporting,predefined) -> Data retrieved from the persistence: {'@persistence_version': 1, 'start_time_in_utc': '2023-07-24 01:23:01', 'last_event_time_in_utc': '2023-07-28 01:23:01', 'last_ids': [], 'next_page_key': None}
2023-07-29T20:42:44.401    INFO InputProcess::LastPassPuller(lastpass,10001,reporting,predefined) -> Running the persistence upgrade steps
2023-07-29T20:42:44.401    INFO InputProcess::LastPassPuller(lastpass,10001,reporting,predefined) -> Running the persistence corrections steps
2023-07-29T20:42:44.401    INFO InputProcess::LastPassPuller(lastpass,10001,reporting,predefined) -> Running the persistence corrections steps
2023-07-29T20:42:44.402    INFO InputProcess::LastPassPuller(lastpass,10001,reporting,predefined) -> No changes were detected in the persistence
2023-07-29T20:42:44.402    INFO InputProcess::LastPassPuller(lastpass,10001,reporting,predefined) -> LastPassPuller(lastpass,10001,reporting,predefined) Finalizing the execution of pre_pull()
2023-07-29T20:42:44.402    INFO InputProcess::LastPassPuller(lastpass,10001,reporting,predefined) -> Starting data collection every 600 seconds
2023-07-29T20:42:44.402    INFO InputProcess::LastPassPuller(lastpass,10001,reporting,predefined) -> Pull Started
2023-07-29T20:42:44.405    INFO InputProcess::LastPassPuller(lastpass,10001,reporting,predefined) -> Fetching all reporting event(s) having Time between 2023-07-28 01:23:01 and 2023-07-29 01:23:01
2023-07-29T20:42:49.893    INFO InputProcess::LastPassPuller(lastpass,10001,reporting,predefined) -> Updating the persistence
2023-07-29T20:42:49.894    INFO InputProcess::LastPassPuller(lastpass,10001,reporting,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1690677764399):Number of requests made: 1; Number of events received: 37; Number of duplicated events filtered out: 0; Number of events generated and sent: 37; Average of events per second: 6.738.
2023-07-29T20:42:49.895    INFO InputProcess::LastPassPuller(lastpass,10001,reporting,predefined) -> Fetching all reporting event(s) having Time between 2023-07-29 00:13:02 and 2023-07-30 00:13:02
2023-07-29T20:42:50.405    INFO InputProcess::LastPassPuller(lastpass,10001,reporting,predefined) -> Updating the persistence
2023-07-29T20:42:50.405    INFO InputProcess::LastPassPuller(lastpass,10001,reporting,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1690677764399):Number of requests made: 2; Number of events received: 262; Number of duplicated events filtered out: 1; Number of events generated and sent: 261; Average of events per second: 43.482.
2023-07-29T20:42:50.405    INFO InputProcess::LastPassPuller(lastpass,10001,reporting,predefined) -> Fetching all reporting event(s) having Time between 2023-07-29 20:42:44 and 2023-07-30 00:42:44
2023-07-29T20:42:54.514    INFO InputProcess::LastPassPuller(lastpass,10001,reporting,predefined) -> No more next_page_key values returned. Setting pull_completed to True.
2023-07-29T20:42:54.520    INFO InputProcess::LastPassPuller(lastpass,10001,reporting,predefined) -> Updating the persistence
2023-07-29T20:42:54.521    INFO InputProcess::LastPassPuller(lastpass,10001,reporting,predefined) -> (Partial) Statistics for this pull cycle (@devo_pulling_id=1690677764399):Number of requests made: 3; Number of events received: 264; Number of duplicated events filtered out: 2; Number of events generated and sent: 262; Average of events per second: 25.893.
```

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

```
2023-07-29T20:42:54.521    INFO InputProcess::LastPassPuller(lastpass,10001,reporting,predefined) -> Statistics for this pull cycle (@devo_pulling_id=1690677764399):Number of requests made: 3; Number of events received: 264; Number of duplicated events filtered out: 2; Number of events generated and sent: 262; Average of events per second: 25.892.
2023-07-29T20:42:54.522    INFO InputProcess::LastPassPuller(lastpass,10001,reporting,predefined) -> The data is up to date!
2023-07-29T20:42:54.522    INFO InputProcess::LastPassPuller(lastpass,10001,reporting,predefined) -> Data collection completed. Elapsed time: 10.123 seconds. Waiting for 589.877 second(s) until the next one
```
</details>

<details>
<summary>Restart the persistence</summary>

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.
</details>

<details>
<summary>Troubleshooting</summary>

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 | 102 | Failed to fetch data from {endpoint}. Source is not pullable. | The provided credentials, base URL, and/or token endpoint are 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. |
</details>

## Collector operations

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

<details>
<summary>Verify collector operations</summary>

### 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:

```
2023-01-10T15:22:57.146    INFO MainProcess::MainThread -> Loading configuration using the following files: {"full_config": "config.yaml", "job_config_loc": null, "collector_config_loc": null}
2023-01-10T15:22:57.146    INFO MainProcess::MainThread -> Using the default location for "job_config_loc" file: "/etc/devo/job/job_config.json"
2023-01-10T15:22:57.147    INFO MainProcess::MainThread -> "\etc\devo\job" does not exists
2023-01-10T15:22:57.147    INFO MainProcess::MainThread -> Using the default location for "collector_config_loc" file: "/etc/devo/collector/collector_config.json"
2023-01-10T15:22:57.148    INFO MainProcess::MainThread -> "\etc\devo\collector" does not exists
2023-01-10T15:22:57.148    INFO MainProcess::MainThread -> Results of validation of config files parameters: {"config": "config.yaml", "config_validated": True, "job_config_loc": "/etc/devo/job/job_config.json", "job_config_loc_default": True, "job_config_loc_validated": False, "collector_config_loc": "/etc/devo/collector/collector_config.json", "collector_config_loc_default": True, "collector_config_loc_validated": False}
2023-01-10T15:22:57.171 WARNING MainProcess::MainThread -> [WARNING] Illegal global setting has been ignored -> multiprocessing: False
```

### 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:

```
2023-01-10T15:23:00.788    INFO OutputProcess::MainThread -> DevoSender(standard_senders,devo_sender_0) -> Starting thread
2023-01-10T15:23:00.789    INFO OutputProcess::MainThread -> DevoSenderManagerMonitor(standard_senders,devo_1) -> Starting thread (every 300 seconds)
2023-01-10T15:23:00.790    INFO OutputProcess::MainThread -> DevoSenderManager(standard_senders,manager,devo_1) -> Starting thread
2023-01-10T15:23:00.842    INFO OutputProcess::MainThread -> global_status: {"output_process": {"process_id": 18804, "process_status": "running", "thread_counter": 21, "thread_names": ["MainThread", "pydevd.Writer", "pydevd.Reader", "pydevd.CommandThread", "pydevd.CheckAliveThread", "DevoSender(standard_senders,devo_sender_0)", "DevoSenderManagerMonitor(standard_senders,devo_1)", "DevoSenderManager(standard_senders,manager,devo_1)", "OutputStandardConsumer(standard_senders_consumer_0)", 
```

#### 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.<br>> ℹ️ 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:<br>- 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.<br>> ℹ️ By default these traces will be shown every 10 minutes. |
</details>

<details>
<summary>Check memory usage</summary>

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`

```
INFO InputProcess::MainThread -> [GC] global: 20.4% -> 20.4%, process: RSS(34.50MiB -> 34.08MiB), VMS(410.52MiB -> 410.02MiB)
INFO OutputProcess::MainThread -> [GC] global: 20.4% -> 20.4%, process: RSS(28.41MiB -> 28.41MiB), VMS(705.28MiB -> 705.28MiB)
```
</details>

## Change log

| **Release** | **Released on** | **Release type** | **Details** | **Recommendations** |
| --- | --- | --- | --- | --- |
| `v1.0.0` | 11/20/2023 | [INITIAL FEATURE] | Initial release | `-` |