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

[FEATURE] Utilities CLI for developing integrations #31

Closed
Swiddis opened this issue Jun 27, 2023 · 0 comments · Fixed by #32
Closed

[FEATURE] Utilities CLI for developing integrations #31

Swiddis opened this issue Jun 27, 2023 · 0 comments · Fixed by #32
Labels
enhancement New feature or request untriaged

Comments

@Swiddis
Copy link
Collaborator

Swiddis commented Jun 27, 2023

Is your feature request related to a problem?

This is a port of an existing issue for a templating CLI. Since that original CLI was developed, a lot has changed about the integrations project, and it's now outdated. Additionally, the needs of developers are much more nuanced, and the templating code is much trickier to port. As such, this issue introduces the idea of a smaller CLI.

What solution would you like?

There are a few tasks that can be automated to assist with integration development, without requiring a full templating tool. These include:

  • Automatically verify the schema of an integration against some data, to detect redundant or incorrectly configured fields.
  • Determine the fields used by an existing visualization in order to help port it to SS4O.
  • Tools for data generation.
  • Tools for code generation of ingestion configs such as:
    • Jaeger
    • FluentBit
    • Data Prepper
    • OTEL Collector
    • Logstash
  • Updated templating tools.

This code can go in the catalog repository, since the catalog is organizing a lot of information and documentation regarding integrations, and in the future we plan on maintaining integrations within the catalog.

What alternatives have you considered?

We can try to update the old CLI, but it's so outdated that it's more effort than it's worth, and trying to fix the templating will distract from implementing simpler functionality that can deliver more immediate value.

Do you have any additional context?

opensearch-project/observability#1451

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request untriaged
Projects
Status: No status
Development

Successfully merging a pull request may close this issue.

1 participant