Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✨Source Datadog: Make Builder Compatible #38148

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions airbyte-integrations/connectors/source-datadog/.dockerignore

This file was deleted.

38 changes: 0 additions & 38 deletions airbyte-integrations/connectors/source-datadog/Dockerfile

This file was deleted.

81 changes: 53 additions & 28 deletions airbyte-integrations/connectors/source-datadog/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,74 +5,99 @@ For information about how to use this connector within Airbyte, see [the documen

## Local development

#### Create credentials
### Prerequisites

* Python (`^3.9`)
* Poetry (`^1.7`) - installation instructions [here](https://python-poetry.org/docs/#installation)



### Installing the connector

From this connector directory, run:
```bash
poetry install --with dev
```


### Create credentials

**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/datadog)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_datadog/spec.yaml` file.
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `src/source_datadog/spec.yaml` file.
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
See `integration_tests/sample_config.json` for a sample config file.
See `sample_files/sample_config.json` for a sample config file.

**If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source datadog test creds`
and place them into `secrets/config.json`.

### Locally running the connector docker image
### Locally running the connector

#### Build
```
poetry run source-datadog spec
poetry run source-datadog check --config secrets/config.json
poetry run source-datadog discover --config secrets/config.json
poetry run source-datadog read --config secrets/config.json --catalog sample_files/configured_catalog.json
```

**Via [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md) (recommended):**
### Running tests

```bash
airbyte-ci connectors --name=source-datadog build
```
To run tests locally, from the connector directory run:

An image will be built with the tag `airbyte/source-datadog:dev`.
```
poetry run pytest tests
```

**Via `docker build`:**
### Building the docker image

1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md)
2. Run the following command to build the docker image:
```bash
docker build -t airbyte/source-datadog:dev .
airbyte-ci connectors --name=source-datadog build
```

#### Run
An image will be available on your host with the tag `airbyte/source-datadog:dev`.

Then run any of the connector commands as follows:

### Running as a docker container

Then run any of the connector commands as follows:
```
docker run --rm airbyte/source-datadog:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-datadog:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-datadog:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-datadog:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
```

## Testing
### Running our CI test suite

You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md):

```bash
airbyte-ci connectors --name=source-datadog test
```

### Customizing acceptance Tests

Customize `acceptance-test-config.yml` file to configure tests. See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference) for more information.
Customize `acceptance-test-config.yml` file to configure acceptance tests. See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference) for more information.
If your connector requires to create or destroy resources for use during acceptance tests create fixtures for it and place them inside integration_tests/acceptance.py.

## Dependency Management
### Dependency Management

All of your dependencies should go in `setup.py`, NOT `requirements.txt`. The requirements file is only used to connect internal Airbyte dependencies in the monorepo for local development.
We split dependencies between two groups, dependencies that are:
All of your dependencies should be managed via Poetry.
To add a new dependency, run:
```bash
poetry add <package-name>
```

- required for your connector to work need to go to `MAIN_REQUIREMENTS` list.
- required for the testing need to go to `TEST_REQUIREMENTS` list
Please commit the changes to `pyproject.toml` and `poetry.lock` files.

### Publishing a new version of the connector
## Publishing a new version of the connector

You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?

1. Make sure your changes are passing our test suite: `airbyte-ci connectors --name=source-datadog test`
2. Bump the connector version in `metadata.yaml`: increment the `dockerImageTag` value. Please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors).
2. Bump the connector version (please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors)):
- bump the `dockerImageTag` value in in `metadata.yaml`
- bump the `version` value in `pyproject.toml`
3. Make sure the `metadata.yaml` content is up to date.
4. Make the connector documentation and its changelog is up to date (`docs/integrations/sources/datadog.md`).
4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/datadog.md`).
5. Create a Pull Request: use [our PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention).
6. Pat yourself on the back for being an awesome contributor.
7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry.
4 changes: 3 additions & 1 deletion airbyte-integrations/connectors/source-datadog/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ data:
pypi:
enabled: true
packageName: airbyte-source-datadog
connectorBuildOptions:
baseImage: docker.io/airbyte/python-connector-base:1.2.0@sha256:c22a9d97464b69d6ef01898edf3f8612dc11614f05a84984451dde195f337db9
registries:
oss:
enabled: true
Expand All @@ -18,7 +20,7 @@ data:
connectorSubtype: api
connectorType: source
definitionId: 1cfc30c7-82db-43f4-9fd7-ac1b42312cda
dockerImageTag: 0.4.0
dockerImageTag: 0.4.1
dockerRepository: airbyte/source-datadog
githubIssueLabel: source-datadog
icon: datadog.svg
Expand Down
Loading
Loading