https://github.com/reservoir-data/tap-honeybadger
Singer tap for Honeybadger.io
https://github.com/reservoir-data/tap-honeybadger
elt meltano singer-tap
Last synced: 2 months ago
JSON representation
Singer tap for Honeybadger.io
- Host: GitHub
- URL: https://github.com/reservoir-data/tap-honeybadger
- Owner: reservoir-data
- License: apache-2.0
- Created: 2024-10-04T05:05:37.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-02-12T00:40:31.000Z (2 months ago)
- Last Synced: 2025-02-12T01:34:03.342Z (2 months ago)
- Topics: elt, meltano, singer-tap
- Language: Python
- Homepage:
- Size: 101 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# tap-honeybadger
Singer tap for [Honeybadger.io](https://honeybadger.io/).
Built with the [Meltano Tap SDK](https://sdk.meltano.com) for Singer Taps.
## Capabilities
* `catalog`
* `state`
* `discover`
* `about`
* `stream-maps`
* `schema-flattening`
* `batch`
## Settings
| Setting | Required | Default | Description |
| :--------- | :------- | :------ | :---------------------------------------- |
| auth_token | True | None | Honeybadger personal authentication token |
| start_date | False | None | Earliest datetime to get data from |
### Inherited Singer SDK Settings
| Setting | Required | Default | Description |
| :-------------------------------- | :------- | :------ | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| stream_maps | False | None | Config object for stream maps capability. For more information check out [Stream Maps](https://sdk.meltano.com/en/latest/stream_maps.html). |
| stream_map_config | False | None | User-defined config values to be used within map expressions. |
| faker_config | False | None | Config for the [`Faker`](https://faker.readthedocs.io/en/master/) instance variable `fake` used within map expressions. Only applicable if the plugin specifies `faker` as an addtional dependency (through the `singer-sdk` `faker` extra or directly). |
| faker_config.seed | False | None | Value to seed the Faker generator for deterministic output: https://faker.readthedocs.io/en/master/#seeding-the-generator |
| faker_config.locale | False | None | One or more LCID locale strings to produce localized output for: https://faker.readthedocs.io/en/master/#localization |
| 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 | |
| batch_config.encoding | False | None | Specifies the format and compression of the batch files. |
| batch_config.encoding.format | False | None | Format to use for batch files. |
| batch_config.encoding.compression | False | None | Compression format to use for batch files. |
| batch_config.storage | False | None | Defines the storage layer to use when writing batch files |
| batch_config.storage.root | False | None | Root path to use when writing batch files. |
| batch_config.storage.prefix | False | None | Prefix to use when writing batch files. |
A full list of supported settings and capabilities is available by running: `tap-honeybadger --about`
### Source Authentication and Authorization
A personal authentication token is available in the [Honeybadger user profile page](https://app.honeybadger.io/users/edit).
## Usage
You can easily run `tap-honeybadger` by itself or in a pipeline using [Meltano](https://meltano.com/).
### Executing the Tap Directly
```bash
tap-honeybadger --version
tap-honeybadger --help
tap-honeybadger --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
```bash
uv tool install --with tox-uv tox
```
### Create and Run Tests
Run all tests:
```bash
tox run-parallel
```
### Testing with [Meltano](https://www.meltano.com)
_**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. Go ahead and [install Meltano](https://docs.meltano.com/getting-started/installation/) if you haven't already.
1. Install all plugins
```bash
meltano install
```
1. Check that the extractor is working properly
```bash
meltano invoke tap-honeybadger --version
```
1. Execute an ELT pipeline
```bash
meltano run tap-honeybadger target-jsonl
```
### SDK Dev Guide
See the [dev guide](https://sdk.meltano.com/en/latest/dev_guide.html) for more instructions on how to use the SDK to
develop your own taps and targets.