Send Thinkst Canary logs to LogPulse

The alerts of your Canaries and Canarytokens, and the console audit trail. Someone touched a decoy, so there is almost always someone in your network who should not be.

In short
To send Thinkst Canary logs to LogPulse, add Thinkst Canary under Configure → Sources → Cloud. LogPulse reads the Canary console API itself, without an agent. Events land in the network, audit indexes with source canary and fill the Intrusion Detection data model.

Overview

How Thinkst Canary data reaches LogPulse
Vendor
Canary console API
Collect
Integration pollerreads new events, maps the fields
Store
index=network
index=audit
  1. Canary console API to Integration poller
  2. Integration poller to index=network
  3. Integration poller to index=audit

LogPulse signs in to Thinkst Canary with the credential you give it and fetches new events every five minutes by default. You can set the interval per integration, from one minute to 24 hours.

What you need

  • A Canary console and an API key (read-only is enough)
  • In LogPulse: a role that may manage API keys. Cloud integrations fall under that right.

1. Create a credential in Thinkst Canary

Field in LogPulseWhere you find it
ConsoleThe address of your Canary console, such as abc123.canary.tools.
API auth tokenIn the console: Settings, API, Add API key. A read-only key is enough. Stored encrypted and never shown again.

2. Add the integration in LogPulse

Go to Configure → Sources → Cloud and choose Thinkst Canary. Fill in the fields, tick the data sources you want and save. LogPulse first tests the connection with your credential and tells you what is wrong when it fails.

Tip: Secrets are stored encrypted and never shown again. To change one, paste a new value; the rest stays.

What arrives

Data sourceIndexSourceSourcetypeWhat it holds
Incidentsnetworkcanarycanarytools:incidentEach alert of a Canary or Canarytoken: what was touched, from which address and port, and how often. Arrives with category=deception.
Audit trail (off by default)auditcanarycanarytools:auditChanges in the Canary console: who changed settings, acknowledged alerts or created tokens.

The index is the kind of data and the source is the product, so detection rules for that kind of data find Thinkst Canary without changes.

Note: Every Canary alert arrives as high severity. The first read takes the alerts of the last seven days.
Note: LogPulse never acknowledges or deletes alerts in your console.

Fields and data models

Data modelWhat you get
Intrusion DetectionAlerts with the attacker address (src), the decoy (dest), port and what was touched.

Field names follow the CIM field names. These are the fields LogPulse sets on Thinkst Canary events; a field is left out when Thinkst Canary did not send a value.

  • action
  • console
  • count
  • description
  • dest
  • dest_id
  • dest_ip
  • dest_port
  • group
  • http_user_agent
  • id
  • signature
  • src
  • src_ip
  • src_port
  • status
  • user
  • vendor_action

The original record of Thinkst Canary is kept with each event under raw, so nothing the vendor sent is lost.

3. Check the data

The first events arrive within a few minutes. Check what came in:

earliest=-1h index IN (network, audit) source IN (canary)
| stats count by index, source, sourcetype

The integration page in LogPulse shows when it last read events and the last error, if any.

Troubleshooting

The connection test names what is wrong. These are the answers you are most likely to see.

What you seeWhat to do
The console refused the API auth token.Create a new API key in the console under Settings, API. A read-only key is enough.
consoleUrl is your console, e.g. abc123.canary.toolsFill in the address of your own console, or only the part before .canary.tools.
The test passes but no events arrive.Run the search above over a longer time. No results: check on the integration page that the data source is switched on and when it last read events. Thinkst Canary may also simply have had nothing new.

Frequently asked questions

How do I send Thinkst Canary logs to LogPulse?
Add the Thinkst Canary cloud integration under Configure, Sources, Cloud in LogPulse and fill in Console, API auth token. LogPulse reads the Canary console API itself, every five minutes by default; there is nothing to install.
Which permissions does LogPulse need in Thinkst Canary?
A Canary console and an API key (read-only is enough). Read access is enough for collecting logs.
Which index does Thinkst Canary data go to?
The index is the kind of data: network, audit. The source is the product: canary. Each data source has its own sourcetype, listed on this page.
Which data models does Thinkst Canary fill?
Intrusion Detection. Detection rules and dashboards written for a data model work on Thinkst Canary without changes.
Why is Audit trail off by default?
To keep your daily ingest down until you need it: Audit trail is high volume or of use to fewer teams. Tick the data source in the integration to switch it on.
Does LogPulse acknowledge or delete Canary alerts?
No. LogPulse only reads. Alerts stay as they are in your Canary console.
Why is every Canary alert high severity?
Nobody has a reason to touch a decoy, so an alert almost always means someone is in your network who should not be. Alerts arrive with category=deception in the network index.