Skip to content

Latest commit

 

History

History
419 lines (374 loc) · 71.7 KB

on_boarding.md

File metadata and controls

419 lines (374 loc) · 71.7 KB
graph LR
    DogStatsd_Client["DogStatsd Client"]
    DogStatsd_Context_Managers["DogStatsd Context Managers"]
    Dogshell_CLI_Core["Dogshell CLI Core"]
    Dogshell_API_Clients["Dogshell API Clients"]
    ThreadStats_Client["ThreadStats Client"]
    ThreadStats_AWS_Lambda_Integration["ThreadStats AWS Lambda Integration"]
    Datadog_API_Client["Datadog API Client"]
    Utility_Core["Utility - Core"]
    DogStatsd_Client -- "uses" --> DogStatsd_Context_Managers
    DogStatsd_Client -- "depends on" --> Utility_Core
    DogStatsd_Context_Managers -- "interacts with" --> DogStatsd_Client
    Dogshell_CLI_Core -- "initializes" --> Datadog_API_Client
    Dogshell_CLI_Core -- "dispatches to" --> Dogshell_API_Clients
    Dogshell_CLI_Core -- "depends on" --> Utility_Core
    Dogshell_API_Clients -- "uses" --> Datadog_API_Client
    Dogshell_API_Clients -- "depends on" --> Utility_Core
    ThreadStats_Client -- "uses" --> Datadog_API_Client
    ThreadStats_Client -- "integrates with" --> ThreadStats_AWS_Lambda_Integration
    ThreadStats_Client -- "depends on" --> Utility_Core
    ThreadStats_AWS_Lambda_Integration -- "uses" --> ThreadStats_Client
    ThreadStats_AWS_Lambda_Integration -- "uses" --> Datadog_API_Client
    Datadog_API_Client -- "depends on" --> Utility_Core
    click DogStatsd_Client href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/datadogpy/DogStatsd Client.md" "Details"
    click DogStatsd_Context_Managers href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/datadogpy/DogStatsd Context Managers.md" "Details"
    click Dogshell_CLI_Core href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/datadogpy/Dogshell CLI Core.md" "Details"
    click Dogshell_API_Clients href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/datadogpy/Dogshell API Clients.md" "Details"
    click ThreadStats_Client href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/datadogpy/ThreadStats Client.md" "Details"
    click ThreadStats_AWS_Lambda_Integration href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/datadogpy/ThreadStats AWS Lambda Integration.md" "Details"
    click Datadog_API_Client href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/datadogpy/Datadog API Client.md" "Details"
    click Utility_Core href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/datadogpy/Utility - Core.md" "Details"
Loading

CodeBoardingDemoContact

Component Details

The datadogpy library provides Python clients for interacting with Datadog services. It primarily consists of two main data reporting mechanisms: the DogStatsd Client for sending metrics, events, and service checks to a local Datadog Agent via UDP/UDS, and the Datadog API Client for direct HTTP API interactions. Additionally, it offers a ThreadStats Client for asynchronous metric reporting, especially useful in serverless environments like AWS Lambda, and a Dogshell CLI for command-line management of Datadog resources. Core utility components support these functionalities by handling hostname resolution, configuration, compatibility, and data formatting.

DogStatsd Client

Provides core functionality for sending metrics, events, and service checks to the Datadog Agent via UDP or UDS, including initialization, socket management, buffering, flushing, and metric aggregation.

Related Classes/Methods:

DogStatsd Context Managers

Provides context managers and decorators for automatically timing code blocks and managing distributed tracing contexts for DogStatsd metrics.

Related Classes/Methods:

Dogshell CLI Core

The main entry point for the dogshell command-line application, handling argument parsing, configuration loading, error reporting, and dispatching commands to specific CLI clients.

Related Classes/Methods:

Dogshell API Clients

Provides various client classes for interacting with specific Datadog API resources via the command-line interface, encapsulating logic for CRUD operations on different Datadog services.

Related Classes/Methods:

ThreadStats Client

A client for sending metrics and events in multi-threaded or asynchronous environments, managing flushing and reporting of aggregated data, particularly useful for serverless functions.

Related Classes/Methods:

ThreadStats AWS Lambda Integration

Provides specific integration for Datadog ThreadStats within AWS Lambda environments, enabling automatic metric collection and handling the lifecycle of the ThreadStats client in a serverless context.

Related Classes/Methods:

Datadog API Client

The foundational component for all interactions with the Datadog HTTP API, managing API key authentication, request submission, error handling, retry logic, and providing interfaces for various Datadog API endpoints.

Related Classes/Methods:

Utility - Core

Provides essential utility functions for the library, including hostname determination, configuration file management, Python version compatibility, and data formatting (tags, JSON, time series).

Related Classes/Methods:

FAQ