Skip to content

Update /about API #705

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Mar 17, 2024
Merged

Update /about API #705

merged 1 commit into from
Mar 17, 2024

Conversation

@Eshanatnight
Copy link
Contributor

@Eshanatnight Eshanatnight commented Mar 15, 2024

This PR contains the ingester side changes

Fixes #704 .

Update the /about response to return this data

{
    "version": "v0.9.0",
    "uiVersion": "development",
    "commit": "e67e440",
    "deploymentId": "01HRYYAF36P2Q3YT3ZNPN6HGQC",
    "updateAvailable": false,
    "latestVersion": "v0.9.0",
    "llmActive": false,
    "llmProvider": null,
    "oidcActive": false,
    "license": "AGPL-3.0-only",
    "mode": "ingest / query",
    "staging": "<blank for query, path for ingester>",
    "cache": "Disabled",
    "grpcPort": 8001,
    "store": {
        "type": "S3 / local drive",
        "path": "http://localhost:9000/bucketname" // for distributed, data dir path for standalone server
    }
}

Description

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.

@Eshanatnight
add + update about api
b93da2e 
1. Add About API for Ingest Servers
2. Update About API Response

```
{
    "version": current_version,
    "uiVersion": ui_version,
    "commit": commit,
    "deploymentId": deployment_id,
    "updateAvailable": update_available,
    "latestVersion": latest_release,
    "llmActive": is_llm_active,
    "llmProvider": llm_provider,
    "oidcActive": is_oidc_active,
    "license": "AGPL-3.0-only",
    "mode": mode,
    "staging": staging,
    "cache": cache_details,
    "grpcPort": grpc_port,
    "store": {
        "type": CONFIG.get_storage_mode_string(),
        "path": store_endpoint
    }
}
```
@Eshanatnight Eshanatnight changed the title feat: distributed Implementation of the Parseable Server (#656) Update /about API Mar 15, 2024
@nikhilsinhaparseable nikhilsinhaparseable self-requested a review March 17, 2024 15:35
@nikhilsinhaparseable nikhilsinhaparseable merged commit ec707ab into parseablehq:distributed Mar 17, 2024
@Eshanatnight Eshanatnight deleted the about-api-update branch March 17, 2024 16:52
@nitisht nitisht mentioned this pull request Mar 18, 2024
Closed
Eshanatnight added a commit to Eshanatnight/parseable that referenced this pull request Apr 1, 2024
@Eshanatnight
Update /about API (parseablehq#705)
461a2ec 
add + update about api

1. Add About API for Ingest Servers
2. Update About API Response

```
{
    "version": current_version,
    "uiVersion": ui_version,
    "commit": commit,
    "deploymentId": deployment_id,
    "updateAvailable": update_available,
    "latestVersion": latest_release,
    "llmActive": is_llm_active,
    "llmProvider": llm_provider,
    "oidcActive": is_oidc_active,
    "license": "AGPL-3.0-only",
    "mode": mode,
    "staging": staging,
    "cache": cache_details,
    "grpcPort": grpc_port,
    "store": {
        "type": CONFIG.get_storage_mode_string(),
        "path": store_endpoint
    }
}
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nikhilsinhaparseable nikhilsinhaparseable Awaiting requested review from nikhilsinhaparseable

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Eshanatnight @nikhilsinhaparseable