Skip to content

Implement User-Agent Header Tracking in SDKs with Build Integration #5

@mridang

Description

@mridang

Implement User-Agent Header Tracking in SDKs with Build Integration

Which Problems Are Solved

  • The SDK usage is not currently tracked due to the absence of a versioned User-Agent header.
  • There is no automated mechanism to embed library version information within the SDK artifacts.
  • Outgoing requests do not have a standardized header that includes OS, Arch, Language, Library, and SDK version information.

How the Problems Are Solved

  • User-Agent Header: Add headers to all SDKs to include OS, architecture, language, library version, and SDK version.
  • Build/Release Flow: Modify the build and release process to generate and include a VERSION file in the SDK artifacts, which will be used to read the library version.
  • Testing: Implement tests to ensure that the User-Agent header is set correctly for all outgoing requests from each SDK.

Additional Changes

  • Update SDK documentation to reflect the new header requirements and updated build/release process.
  • Add examples and explanations on how the header is constructed and used for tracking SDK usage.
  • Ensure that build scripts or CI pipelines are updated to include the new VERSION file in the release artifacts.

Additional Context

  • This change is required to track usage metrics of our SDKs through the User-Agent header.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions