Skip to content

bbsankarsh/odd-collectors

BranchesTags
 
 

Repository files navigation

OpenDataDiscovery Collectors.

Generic Collector | AWS Collector | Azure Collector | GCP Collector

What is collector?

Usage example

Collector is a service that loads and runs adapters. Collectors are separated by data sources. Each collector has examples of configuration files for each adapter. Collector works as a daemon and periodically load metadata from data sources. Data sources can be configured in plugins field of collector config. Each plugin has own configuration to connect to data source and load metadata.

What is adapter?

Adapter is an abstraction that allows to load metadata from different data sources. Providing all the necessary information to connect to the data source, adapter can load metadata from it and send it to ODD Platform. Adapters do not have any dependencies on each other and can be used separately. Adapter do not read real data from data source, only metadata.

odd-collector

Image | Configuration examples

Collector to the common data sources, it shares adapters to Databases, Vector Stores (pgvector PostgreSQL extension), BI Tools or ML platforms as MLFlow.

Supported data sources:

odd-collector-aws

Image | Configuration examples

Collector provides adapter for Amazon cloud services

Supported data sources:

odd-collector-azure

Image | Configuration examples

Collector provides adapter for Microsoft Azure cloud services Supported data sources:

odd-collector-gcp

Image | Configuration examples

Collector provides adapter for Google Cloud services. Detailed documentation.

Supported data sources:

Ingestion Filters Configuration

This section provides a comprehensive reference for configuring Ingestion Filters that are available within several ODD Data Collectors. The table below outlines key information about those Collectors along with Adapters, Filter Configuration Parameters and brief Descriptions of Filter for each of them.

Collector Adapter Filter Config Parameter Filter Description
odd-collector PostgreSQL schemas_filter Filter object by database schema name
odd-collector Snowflake schemas_filter Filter object by database schema name
odd-collector-aws S3 filename_filter Filter by file name
odd-collector-aws S3 Delta filter Filter by file name
odd-collector-gcp BigQuery datasets_filter Filter by data set name
odd-collector-gcp Google Cloud Storage filename_filter Filter by file name
odd-collector-gcp Google Cloud Storage Delta filter Filter by file name
odd-collector-azure Azure Data Factory (ADF) pipeline_filter Filter by pipeline name
odd-collector-azure Azure BLOB Storage file_filter Filter by file name

Relationships

The goal of this feature is to build relationships on the top of core data entities that are logically related. The table below represents what adapters currently support this feature and are capable of constructing the Relationship DataEntity. There are 2 types of relationships: ERD(Entity-Relationship Diagram) and GRAPH.

  • ERD relationships represent associations between entities within a relational database. We determine 4 cardinality types of relationships:
    • ONE_TO_EXACTLY_ONE - a single instance of an entity is related to a single instance of another entity.
    • ONE_TO_ZERO_OR_ONE - a single instance of an entity is related to either zero instances or one instance of another entity.
    • ONE_TO_ONE_OR_MORE - a single instance of an entity is related to multiple instances of another entity.
    • ONE_TO_ZERO_ONE_OR_MORE - a single instance of an entity is related to zero instances or one or more instances of another entity.
  • GRAPH relationships refer to connections between entities represented in a graph data structure. For example in Neo4j it will be relationships between nodes.
Collector Adapter Relationship Type Relationship Description
odd-collector PostgreSQL ERD Relationship between 2 related table entities (supports cross-schema relation) that is determined by foreign key constraint
odd-collector Snowflake ERD Relationship between 2 related table entities (supports cross-schema relation) that is determined by foreign key constraint

Collector configuration using alternative Secrets Backend

There is an option to store collector configuration settings via Secrets Backend (only AWS SSM Parameter Store is supported for now). Using this approach you need to create your secrets in the chosen Secret Backend provider according to the naming and backend configuration specified in secrets_backend section of collector_config.yaml. More detailed information with usage examples you can find below in "Usage Example" section. Also some actual information can be found in odd-collector documentation and odd-collector/collector_config.yaml snippet.

Usage Example

Collector configuration

Config file must be named collector_config.yaml and placed in the same directory as the collector package. Collector config fields:

default_pulling_interval: Optional[int] = None # Minutes to wait between runs of the job, if not set, job will be run only once
token: str # Token to access ODD Platform
plugins: list[Plugin] # List of adapters configs to be loaded
platform_host_url: str # URL of ODD Platform instance, i.e. http://localhost:8080
chunk_size: int = 250 # Number of records to be sent in one request to the platform
connection_timeout_seconds: int = 300 # Seconds to wait for connection to the platform
misfire_grace_time: Optional[int] = None  # seconds after the designated runtime that the job is still allowed to be run
max_instances: Optional[int] = 1  # maximum number of concurrently running instances allowed
verify_ssl: bool = True # For cases when self-signed certificates are used

The priority of fields initialization:

  1. Fetching fields from Secrets Backend(if configured, see "Secrets Backend configuration" paragraph). All collector config fields described above can be stored via Secrets Backend. If there is a field configured both in Secrets Backend and in collector_config.yaml the priority is given to the value stored in Secrets Backend. The information for one plugin must be stored in the unified place: all connection settings stored in collector_config.yaml or in Secrets Backend. But there is a possibility to store one plugin in one place, and the other one in the second place. In case information about one plugin(determined by name) is stored in both Secrets Backend and collector_config.yaml the priority is given to the Secrets Backend.
  2. Fetching fields from collector_config.yaml.
  3. Fetching fields from Environment variables(all fields except plugins). Environments variables must have the same name as fields in collector_config.yaml, but they are case-insensitive, so platform_host_url, PLATFORM_HOST_URL and PlAtFoRm_HoSt_UrL - are all valid environment variables names.
  4. Default values setting. For default_pulling_interval, chunk_size, connection_timeout_seconds, misfire_grace_time, max_instances and verify_ssl default values are acceptable(see in fields description above).

If token, plugins and platform_host_url fields are not specified in any way - the collector will throw config parsing error.

Secrets Backend configuration

Secrets Backend section must be specified only in the case when you are using one of the supported backends. In case when you use only local collector_config.yaml file for configuration you might skip the secrets_backend: section (delete it, or left commented). So, if you need this functionality it must be configured in the collector_config.yaml as well as Collector config. As only AWSSystemsManagerParameterStore is supported for now, all the examples are attached to this case for now.

secrets_backend:
  provider: "AWSSystemsManagerParameterStore"
  # the section below is for key-value arguments provider needs
  region_name: "eu-central-1"    # region where you store secrets
  collector_settings_parameter_name: "/odd/collector_config/collector_settings"   # parameter name for storing
                                     # collector settings, default is "/odd/collector_config/collector_settings"
  collector_plugins_prefix: "/odd/collector_config/plugins"   # prefix for parameters, that contain
                            # plugins configurations, default is "/odd/collector_config/plugins"

provider is must have to specify parameter, without default value.

region_name information is retreiving in the following logic:

  1. The most priority has environment variable AWS_REGION, if it is specified - it's value will be used.
  2. If no AWS_REGION provided, the information from collector_config.yaml will be used.
  3. If region_name is not specified, we are trying to retreive AWS region information from instance metadata service (IMDS).
  4. If none of the above worked, adapter will throw an error, as we can not instantiate the connection to the service.

collector_settings_parameter_name and collector_plugins_prefix have the default values, so if naming seems good for you, this parameters can be skipped.

Example of collector config:

secrets_backend:
  provider: "AWSSystemsManagerParameterStore"
  # the section below is for key-value arguments provider needs
  region_name: "eu-central-1"
  collector_settings_parameter_name: "/odd/collector_config/collector_settings"
  collector_plugins_prefix: "/odd/collector_config/plugins"

default_pulling_interval: 10
token: '****'
platform_host_url: http://localhost:8080
chunk_size: 1000
plugins:
  - type: postgresql
    name: postgresql_adapter
    database: database
    host: localhost
    port: 5432
    user: postgres
    password: !ENV ${POSTGRES_PASSWORD}

Using any collector in a docker container:

For more completed example take a look at docker compose for demo.

version: "3.8"
services:
  odd-collector:
    image: ghcr.io/opendatadiscovery/odd-collector:latest
    restart: always
    volumes:
      - collector_config.yaml:/app/collector_config.yaml
    environment:
      - LOGLEVEL=DEBUG # Optional default INFO, use DEBUG for more verbose logs
      - PLATFORM_HOST_URL=${PLATFORM_HOST_URL}
      - POSTGRES_PASSWORD=${POSTGRES_PASSWORD}

For developers

Collectors release process

Big part of this process is automated using GitHub Actions and named "ODD Collector release". Required steps to create a release:

  1. Merge all code changes to the main branch, including manual package version bump (this part is not automated, you need to update version in ./<odd_collector>/__version__.py and ./pyproject.toml files).
  2. Update locally main branch with the command: git pull.
  3. Create tag locally using command: git tag <tag_name>. Where <tag_name> should be named based on the collector you are releasing and it's version number: odd-collector - generic/1.0.0, odd-collector-aws - aws/1.0.0, odd-collector-azure - azure/1.0.0, odd-collector-gcp - gcp/1.0.0.
  4. Push locally created tag to the repository: git push origin <tag_name>.
  5. Go to the GitHub Actions and choose "ODD Collector release" action.
  6. On the right side click "Run workflow" and choose the appropriate tag (in "Use workflow from") and service you are releasing (in "Select service to build"). Example: you are releasing odd-collector, so tag should look like generic/0.1.61 and service - odd-collector.
  7. Click "Run workflow" and wait untill the action completes. In the result the newer image will be published, you can check it here: https://github.com/orgs/opendatadiscovery/packages.
  8. Now go back to the odd-collectors repo - https://github.com/opendatadiscovery/odd-collectors, go to the "Releases" on the right side and edit the release draft (if needed) that was created for you. Naming convention is the following (depends on the service you have released): "Generic ODD Collector 1.0.0", "AWS ODD Collector 1.0.0", "Azure ODD Collector 1.0.0", "GCP ODD Collector 1.0.0".
  9. Save the release changes.

Testing

  1. To invoke tests you should go to the folder of needed collector type. For generic collector - cd odd-collector.
  2. Activate poetry virtual environment with installed dependencies - poetry shell.
  3. Invoke tests - pytest ./tests -v. where -v is a not mandatory option, but it stands for verbose and can give more detailed feedback on tests' results. Also if you want to run tests only for a particular adapter, you can just modify the relative path, like this - pytest ./tests/integration/test_postgres.py -v . Also tests can be invoked with poetry run pytest ./tests/integration/test_postgres.py -v, for instance it can be helpful for making automation testing in github actions, where you can not directly activate venv with poetry shell in the created testing environment.

About

No description, website, or topics provided.

Resources

Readme

License

Apache-2.0 license
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages

  • Python 99.5%
  • Other 0.5%