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

API Routes for Modules #528

Closed
wants to merge 29 commits into from

Conversation

aldrinjenson
Copy link
Contributor

@aldrinjenson aldrinjenson commented Oct 5, 2023

Fixes #512

Description

Adds APIs for connecting Parseable with extendable modules

  • registrations saved in .parseable.json
  • configs saved in stream-name/.stream.json
  • other routes are directly proxied to module path

Final Routes:

GET /api/v1/modules/ : get list of all module names
PUT /api/v1/modules/{module} : update registration for given module
DEL /api/v1/modules/{module} : delete registration for given module

PUT /api/v1/{module}/config/{logstream} : Update config for a given module and proxy to module config path
GET /api/v1/{module}/config/{logstream} : Get config object for a given stream. (Called by module)

ALL /api/v1/{module}/* : directly proxied to module by parseable


This PR has:

  • been tested to ensure log ingestion and log query works.
  • added comments explaining the "why" and the intent of the code wherever would not be obvious for an unfamiliar reader.
  • added documentation for new or modified features or behaviors.

@aldrinjenson aldrinjenson marked this pull request as ready for review October 9, 2023 22:26
@nitisht
Copy link
Member

nitisht commented Oct 10, 2023

@aldrinjenson can you check the Deepsource / Rust issue here

server/Cargo.toml Outdated Show resolved Hide resolved
@aldrinjenson aldrinjenson changed the title Module configs API Routes for Modules Oct 10, 2023
@github-actions github-actions bot locked and limited conversation to collaborators Oct 19, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

API for anomaly detection config
3 participants