Singer tap for Checkly, built with the Meltano SDK for Singer Taps.
Project description
Capabilities
catalog
state
discover
about
stream-maps
schema-flattening
Settings
Setting | Required | Default | Description |
---|---|---|---|
account_id | True | None | Checkly Account ID |
token | True | None | API Token for Checkly |
start_date | False | None | Earliest datetime to get data from |
include_paid_streams | False | 0 | Include streams that require a paid Checkly plan |
stream_maps | False | None | Config object for stream maps capability. For more information check out Stream Maps. |
stream_map_config | False | None | User-defined config values to be used within map expressions. |
flattening_enabled | False | None | 'True' to enable schema flattening and automatically expand nested properties. |
flattening_max_depth | False | None | The max depth to flatten schemas. |
A full list of supported settings and capabilities is available by running: tap-checkly --about
API Coverage
API Endpoint | Supported | Notes |
---|---|---|
/v1/alert-channels |
✅ | |
/v1/alert-notifications |
✅ | Payment required |
/v1/checks |
✅ | |
/v1/check-alerts |
✅ | |
/v1/check-groups |
✅ | |
/v1/check-results/{checkId} |
N/A | Heavily rate-limited |
/v1/dashboards |
✅ | |
/v1/locations |
✅ | |
/v1/maintenance-windows |
✅ | |
/v1/private-locations |
✅ | |
/v1/runtimes |
✅ | |
/v1/snippets |
✅ | |
/v1/variables |
✅ |
A full list of supported settings and capabilities is available by running: tap-checkly --about
Source Authentication and Authorization
Usage
You can easily run tap-checkly
by itself or in a pipeline using Meltano.
Executing the Tap Directly
tap-checkly --version
tap-checkly --help
tap-checkly --config CONFIG --discover > ./catalog.json
Developer Resources
Initialize your Development Environment
pipx install poetry
poetry install
Create and Run Tests
Create tests within the tests
subfolder and then run:
poetry run pytest
You can also test the tap-checkly
CLI interface directly using poetry run
:
poetry run tap-checkly --help
Testing with Meltano
Note: This tap will work in any Singer environment and does not require Meltano. Examples here are for convenience and to streamline end-to-end orchestration scenarios.
Your project comes with a custom meltano.yml
project file already created.
Install Meltano (if you haven't already) and any needed plugins:
# Install meltano
pipx install meltano
# Initialize meltano within this directory
cd tap-checkly
meltano install
Now you can test and orchestrate using Meltano:
# Test invocation:
meltano invoke tap-checkly --version
# OR run a test `elt` pipeline:
meltano elt tap-checkly target-jsonl
SDK Dev Guide
See the dev guide for more instructions on how to use the SDK to develop your own taps and targets.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for tap_checkly-0.0.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | efc9e03f4c0c6e8568cf17f305160b4fc0c3176e527cc3b337352a156660f066 |
|
MD5 | 1274e54f3186a57a76a1e8f5383ff8fc |
|
BLAKE2b-256 | ed22455a97534a6973a01674958ed2aa36ef823ff85306e2381e5b7eeba2e207 |