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

Internal PR #6

Closed
wants to merge 36 commits into from
Closed

Internal PR #6

wants to merge 36 commits into from

Conversation

AkhigbeEromo
Copy link
Collaborator

@AkhigbeEromo AkhigbeEromo commented Dec 23, 2024

Add Sematext Exporter: Initial Structure

Description

This PR introduces the foundational structure for the Sematext Exporter component. It establishes the necessary files and configurations to set up the exporter without including its full implementation. The goal is to create a clear and reviewable framework for the component, with subsequent PRs to handle the full implementation and additional functionality.


Included in This PR

  1. Factory Implementation

    • Implements the factory to define the basic structure for creating the Sematext Exporter.
    • Includes a method to provide the default configuration.
  2. Configuration Structure

    • Defines the configuration structure for the Sematext Exporter.
    • Includes validation logic to ensure configurations are correct.
  3. README File

    • Adds a README file with an overview of the Sematext Exporter, including its purpose, supported telemetry types, and configuration options.
  4. Metadata File

    • Introduces a metadata.yaml file to describe the component's type, status, stability, and codeowners.
  5. Basic Unit Tests

    • Provides basic unit tests to validate the configuration structure, covering both valid and invalid configurations.
  6. Makefile

    • Adds a Makefile that references the repository’s common Makefile for consistent builds.
  7. Documentation File

    • Includes a doc.go file with directives for metadata generation and a high-level package description.
  8. Optional Placeholder Files

    • Adds placeholder files for the exporter’s future implementation, if necessary.

Checklist

  • All required files and structures are included.
  • Configuration validation logic is in place.
  • Unit tests are written and passing.
  • The README file describes the component and its configuration.
  • Metadata file is correctly formatted and includes required fields.
  • Makefile references the repository’s common Makefile.
  • Build process verified without errors.

Next Steps

Future PRs will include:

  • The complete implementation of the Sematext Exporter.
  • Additional tests to ensure full coverage.
  • Updates to mark the component as Alpha stability once the implementation is finalized.

@AkhigbeEromo AkhigbeEromo changed the title Sc 20424 otel contrib branch Internal PR Dec 23, 2024
@AkhigbeEromo
Copy link
Collaborator Author

This is how the first PR for Doris Exporter looked like:
open-telemetry#33790
The main details should actually go to the issue, not the PRs, once we are sure everything is good with logs support I will update our issue with information from the logs side of things

@AkhigbeEromo AkhigbeEromo marked this pull request as ready for review January 9, 2025 13:31
Copy link

@cpipilas cpipilas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

left comments

exporter/sematextexporter/README.md Outdated Show resolved Hide resolved
exporter/sematextexporter/README.md Outdated Show resolved Hide resolved
exporter/sematextexporter/README.md Outdated Show resolved Hide resolved
exporter/sematextexporter/config.go Outdated Show resolved Hide resolved
exporter/sematextexporter/config.go Outdated Show resolved Hide resolved
exporter/sematextexporter/config.go Outdated Show resolved Hide resolved
exporter/sematextexporter/config_test.go Outdated Show resolved Hide resolved
exporter/sematextexporter/doc.go Outdated Show resolved Hide resolved
exporter/sematextexporter/testdata/config.yaml Outdated Show resolved Hide resolved
exporter/sematextexporter/metadata.yaml Outdated Show resolved Hide resolved
@AkhigbeEromo AkhigbeEromo requested a review from cpipilas January 10, 2025 11:22
Copy link

@cpipilas cpipilas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have anything more to comment.

@AkhigbeEromo AkhigbeEromo reopened this Jan 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants