dsh-sdk-platform-rs

Description

This library can be used to interact with the DSH Platform. It is intended to be used as a base for services that will be used to interact with DSH. It is not intended to be used directly. Features include:

• Connect to DSH
• Fetch Kafka Properties and certificates
• Common functions
  • Preconfigured RDKafka client config
  • Preconfigured Reqwest client config (for schema store)
• Graceful shutdown
• Prometheus Metrics (web server and re-export of metrics crate)
• Dead Letter Queue (experimental)

Usage

To use this SDK with the default features in your project, add the following to your Cargo.toml file:

[dependencies]
dsh_sdk = "0.4"

However, if you would like to use only specific features, you can specify them in your Cargo.toml file. For example, if you would like to use only the bootstrap feature, add the following to your Cargo.toml file:

[dependencies]
dsh_sdk = { version = "0.4", default-features = false, features = ["bootstrap"] }

See feature flags for more information on the available features.

To use this SDK in your project

use dsh_sdk::Properties;
use dsh_sdk::rdkafka::consumer::{Consumer, StreamConsumer};

fn main() -> Result<(), Box<dyn std::error::Error>>{
    let dsh_properties = Properties::get();
    // get a rdkafka consumer config for example
    let consumer: StreamConsumer = dsh_properties.consumer_rdkafka_config().create()?;
}

Feature flags

The following features are available in this library and can be enabled/disabled in your Cargo.toml file.:

See api documentation for more information on how to use these features including.

Environment variables

The default RDKafka config can be overwritten by setting the following environment variables:

KAFKA_BOOTSTRAP_SERVERS

• Usage: Overwrite hostnames of brokers (useful for local testing)
• Default: Brokers based on datastreams
• Required: false

KAFKA_CONSUMER_GROUP_TYPE

• Usage: Picks group_id based on type from datastreams
• Default: Shared
• Options: private, shared
• Required: false

KAFKA_GROUP_ID

• Usage: Custom group id
• Default: NA
• Required: false
• Remark: Overrules KAFKA_CONSUMER_GROUP_TYPE. Mandatory to start with tenant name. (will prefix tenant name automatically if not set)

KAFKA_ENABLE_AUTO_COMMIT

• Usage: Enable/Disable auto commit
• Default: false
• Required: false
• Options: true, false

KAFKA_AUTO_OFFSET_RESET

• Usage: Set the offset reset settings to start consuming from set option.
• Default: earliest
• Required: false
• Options: smallest, earliest, beginning, largest, latest, end

Api doc

See the api documentation for more information on how to use this library.

Local development

You can start the docker-compose file to start a local Kafka broker and Schema Registry.

When running the SDK on your local machine, it will automatically try to connect to the local Kafka broker and Schema Registry

If you want manipulate these endpoints, or want to use specific datastream info, you can add a local_datastreams.json to your project root to overwrite the default values or set the environment variables accordingly.

Note

Rdkafka and thereby this library is dependent on CMAKE. Make sure it is installed in your environment and/or Dockerfile where you are compiling. See dockerfile in example_dsh_service for an example.

Examples

See folder dsh_sdk/examples for simple examples on how to use the SDK.

Full service example

See folder example_dsh_service for a full service, including how to build the Rust project and post it to Harbor. See readme for more information.

Changelog

See CHANGELOG.md for all changes per version.

Contributing

See CONTRIBUTING.md for more information on how to contribute to this project.

License

See LICENSE for more information on the license for this project.

Security

See SECURITY.md for more information on the security policy for this project.

Copyright (c) Koninklijke KPN N.V.