Page Comparison

Table of Contents

minLevel	2
maxLevel	2
type	flat

Overview

Lark is an all-in-one productivity solution that includes chat, scheduling, docs, video conferencing, auto-translation and more in a single platform.

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
`audit_infos`	Returns all the audit logs.	`admin/v1/audit_infos`	`audit_infos`	`app.lark.audit.event`	`v1.0.0`

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

Flattening preprocessing

Data source	Collector service	Optional	Flattening details
`audit_infos`	`audit_infos`	`yes`	not required

Minimum configuration required for basic pulling

...

Info
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
`app_id`	The app ID to generate the auth token for authentication.
`app_secret`	The app secret key to.generate the auth token for authentication.

...

API limits, delays, known Issues

The

...

API only allows 2 valid auth tokens at a time, so you should avoid using the credentials used for the collector should not be used somewhere else while its running.

Accepted authentication methods

Authentication method

app_id

app_secret

Bearer auth token

Status

colour	Green
title	REQUIRED

Status

colour	Green
title	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).

Rw ui tabs macro

Rw tab

title	On-premise collector

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:

Code Block

<any_directory>
└── devo-collectors/
    └── <product_name>/
        ├── certs/
        │   ├── chain.crt
        │   ├── <your_domain>.key
        │   └── <your_domain>.crt
        ├── state/
        └── config/ 
            └── config.yaml

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

Note
Replace `<product_name>` with the proper value.

Editing the config.yaml file

Code Block

globals:
 debug: false
 id: not_used
 name: lark_collector
 persistence:
   type: filesystem
   config:
     directory_name: state
outputs:
  devo_1:
    type: devo_platform
    config:
      address: <your-ingestion-endpoint>
      port: 443
      type: SSL
      chain: chain.crt
      cert: <your_domain>.crt
      key: <your_domain>.key
inputs:
 lark:
   id: <short_unique_id>
   enabled: <input_status>
   credentials:
     app_id: <app_id_value>
     app_secret: <app_secret_value>
   services:
     audit_infos:
       initial_start_time_in_utc: <start_time_in_utc_value>
       override_tag: <override_tag_value>
       event_name : <event_name_value>
       operator_value: <operator_value>
       event_module: <event_module_value>
       operator_type: <operator_type_value>

Info
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
`<short_unique_id>`	`int`	Mandatory	Minimum Length 5	Use this param to give a unique id to this input service. This parameter is used to build the persistence address, do not use the same value for multiple collectors. It could cause a collision.
`<input_status>`	`bool`	Mandatory	false / true	Use this param to enable or disable the given input logic when running the collector. If the value is true, the input will be run. If the value is false, it will be ignored.
`<app_id_value>`	`str`	Mandatory	Minimum Length 1	App id for Lark developer
`<app_secret_value>`	`str`	Mandatory	Minimum Length 1	App secret key for Lark developer
`<override_devo_value>`	`str`	Optional	A devo tag	This parameter allows defining a custom devo tag.
`<event_name_value>`	`str`	Optional	Minimum Length 1	Behavioral audit event name, such ascreate_doc. For names of optional events, see List of enumerated values
`<operator_value>`	`str`	Optional	Minimum Length 1	Operator value
`<event_module_value>`	`int`	Optional	Minimum Length 1	Behavioral audit event module. For the event modules of behavioral audit, see List of enumerated values
`<operator_type_value>`	`str`	Optional	Minimum Length 1	Operator type value
`<start_time_in_utc_value>`	`str`	Mandatory	UTC format/ `Not more than 180 days old` from current date	Start date to pull data from

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-lark_suite_if-docker-image-1.02.0	`77c7388de90e350bc50ff5c3f5f8a8342d02b985b6e1f5ad8aa30a0fdf642ce7e408cb005ec4be2cde19b741439fc821c5da7a052ce715e2bec5a6492879afb7`

Use the following command to add the Docker image to the system:

Code Block
gunzip -c <image_file>-<version>.tgz \| docker load

Note
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>/

Code Block

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>

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

Code Block

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:

Code Block
IMAGE_VERSION=<version> docker-compose up -d

Note
Replace `<product_name>`, `<image_name>` and `<version>` with the proper values.

Rw tab

title	Cloud collector

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 and we will guide you through the configuration.

...

Expand

title	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

Code Block

2023-11-10T09:57:53.856    INFO InputProcess::MainThread -> [GC] global: 39.1% -> 39.1%, process: RSS(68.84MiB -> 68.84MiB), VMS(503.30MiB -> 503.30MiB)
2023-11-10T09:58:53.862    INFO OutputProcess::MainThread -> [GC] global: 39.1% -> 39.1%, process: RSS(49.12MiB -> 49.12MiB), VMS(928.57MiB -> 928.57MiB)

Info

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

22 Jul 2024

Status

colour	Green
title	IMPROVEMENTS

Improvements

Updated the DCSDK from 1.11.1 to v1.12.2
Added new sender for relay in house + TLS
Added persistence functionality for gzip sending buffer
Added Automatic activation of gzip sending
Improved behaviour when persistence fails
Upgraded DevoSDK dependency
Fixed console log encoding
Restructured python classes
Improved behavior with non-utf8 characters
Decreased defaut size value for internal queues (Redis limitation, from 1GiB to 256MiB)
New persistence format/structure (compression in some cases)
Removed dmesg execution (It was invalid for docker execution)
DevoSDK has been updated to version 5.4.0

Bug fixing

Fixed the access token invalid bug.

Update

v1.0.0

01 Jul 2024

Status

colour	Purple
title	INITIAL VERSION

-

Versions Compared

Old Version 1

New Version Current

Key

Overview

Devo collector features

Data sources

Flattening preprocessing

Minimum configuration required for basic pulling

API limits, delays, known Issues

Accepted authentication methods

Run the collector

Structure

Devo credentials

Editing the config.yaml file

Download the Docker image

Docker

Docker Compose

Change log

Improvements

Bug fixing