Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

We use a piece of software called Collector Server to host and manage all our available collectors.

To enable the collector for a customer:

  1. In the Collector Server GUI, access the domain in which you want this instance to be created

  2. Click Add Collector and find the one you wish to add.

  3. In the Version field, select the latest value.

  4. In the Collector Name field, set the value you prefer (this name must be unique inside the same Collector Server domain).

  5. In the sending method select Direct Send. Direct Send configuration is optional for collectors that create Table events, but mandatory for those that create Lookups.

  6. In the Parameters section, establish the Collector Parameters as follows below:

Editing the JSON configuration

Code Block
{
  "global_overrides": {
    "debug": False
  },
  "inputs": {
    "onepassword": {
      "id": "<short_unique_id>",
      "enabled": <input_status>,
      "requests_per_second": <requests_per_second_value>,
      "base_url": <url_value>,
      "credentials": {
        "token": "<token_value>"
      },
      "services": {
        "item_usage": {
          "request_period_in_seconds": <request_period_in_seconds_value>,
          "tag_override": <tag_override_value>,
          "start_time_override": <start_time_override_value>,
          "limit_override": <limit_override_value>
        },
        "sign_in_attempts": {
          "request_period_in_seconds": <request_period_in_seconds_value>,
          "tag_override": <tag_override_value>,
          "start_time_override": <start_time_override_value>,
          "limit_override": <limit_override_value>
        },
        "audit": {
          "request_period_in_seconds": <request_period_in_seconds_value>,
          "tag_override": <tag_override_value>,
          "start_time_override": <start_time_override_value>,
          "limit_override": <limit_override_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.

Please replace the placeholders with real world values following the description table below:

Parameter

Data Type

Type

Value Range / Format

Details

id

int

Mandatory

Minimum length: 1
Maximum length: 5

Use this param to give an unique id to this input service.

Note

This parameter is used to build the persistence address, do not use the same value for multiple collectors. It could cause a collision.

enabled

bool

Mandatory

false / true

If the value is true, the input definition will be executed. If the value is false, the service will be ignored.

requests_per_second

int

Optional

Minimum value: 1

Customize the maximum number of API requests per second. If not used, the default setting will be used: 60 requests/sec.

This parameter should be removed if it is not used.

base_url

str

Mandatory

The URL must be one of the servers detailed here.

Use this param to define the URL used by the collector to pull data. Replace with your 1password Server URL

token

str

Mandatory

Minimum length: 1

Access token created in the 1Password console.

request_period_in_seconds_value

int

Optional

Minimum length: 1

Period in seconds used between each data pulling, this value will overwrite the default value (60 seconds)

This parameter should be removed if it is not used.

start_time_override

str

Optional

UTC with format: YYYY-mm-ddTHH:MM:SS

This configuration allows you to set a custom date as the beginning of the period to download. This allows downloading historical data before downloading new events.

If this setting is not set, the default value is one hour before the current time.

This parameter should be removed if it is not used.

tag_override

str

Optional

See Devo Docs on tagging format and conventions.

https://docs.devo.com/space/latest/95126204/About+Devo+tags

This configuration allows you to set a custom tag.

This parameter should be removed if it is not used.

limit_override

int

Optional

Minimum length: 1
Maximum length: 1000

How many events should be returned in a single request.

If this setting is not set, the default value is 100 events/request.

This parameter should be removed if it is not used.

...

Change log for v1.0.0

Release

Released on

Release type

Details

Recommendations

v1.0.1

Status
colourGreen
titleV1

Release Version

Recommended version

v1.0.0

Status
colourGreen
titleV1

Release Version

Recommended version

...