Skip to content

README.md

Latest commit

 

History

History
123 lines (90 loc) · 4.77 KB

README.md

File metadata and controls

123 lines (90 loc) · 4.77 KB

tap-betterstack

Singer tap for Better Stack. Built with the Meltano Singer SDK.

Capabilities
  • catalog
  • state
  • discover
  • about
  • stream-maps
  • schema-flattening
  • batch

Settings

Setting Required Default Description
token True None API Token for Better Stack
start_date False None Earliest datetime to get data from
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.
batch_config False None

A full list of supported settings and capabilities is available by running: tap-betterstack --about

Streams

Supported

Planned (PRs welcome!)

Usage

You can easily run tap-betterstack by itself or in a pipeline using Meltano.

Executing the Tap Directly

tap-betterstack --version
tap-betterstack --help
tap-betterstack --config CONFIG --discover > ./catalog.json

Developer Resources

  • Developer TODO: As a first step, scan the entire project for the text "TODO:" and complete any recommended steps, deleting the "TODO" references once completed.

Initialize your Development Environment

curl -LsSf https://astral.sh/uv/install.sh | sh  # or see https://docs.astral.sh/uv/getting-started/installation/
uv sync

Create and Run Tests

Create tests within the tests subfolder and then run:

uv run pytest

You can also test the tap-betterstack CLI interface directly using the virtual environment:

uv run tap-betterstack --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.

Use Meltano to run an EL pipeline:

uvx meltano invoke tap-betterstack --version
uvx meltano run tap-betterstack 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.