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

add API for exporting dashboard #401

Closed
mmguero opened this issue Nov 4, 2024 · 0 comments
Closed

add API for exporting dashboard #401

mmguero opened this issue Nov 4, 2024 · 0 comments
Assignees
Labels
api Related to issues dealing with the Malcolm REST API dashboards Relating to Malcolm's OpenSearch Dashboards interface doc Relating to Malcolm documentation enhancement New feature or request
Milestone

Comments

@mmguero
Copy link
Collaborator

mmguero commented Nov 4, 2024

EDIT:

Rather than a script, I realized creating an API for this would be more generally useful.

Original issue context:

@mmguero cloned issue idaholab/Malcolm#439 on 2024-03-13:

The contributor's guide gives instructions for exporting a newly created dashboard for inclusion in ./dashboards/dashboards in the Malcolm source repository, but this would be better to be at least a script. I think ideally the script would live inside the dashboards-helper container and could be executed using docker compose and avoid having to have dependencies outside the container.

The script would need to:

  1. call the /dashboards/api/opensearch-dashboards/dashboards/export API to get the dashboard by ID (perhaps it could be looked up by name, but ID is surer)

  2. remove the arkime_sessions3-* index pattern definition section completely

  3. replace the string arkime_sessions3-* with MALCOLM_NETWORK_INDEX_PATTERN_REPLACER and malcolm_beats_* with MALCOLM_OTHER_INDEX_PATTERN_REPLACER

  4. in my opinion, set any instances of highlightAll in the JSON to false

  5. return the exported/scrubbed dashboard JSON file

@mmguero mmguero added dashboards Relating to Malcolm's OpenSearch Dashboards interface doc Relating to Malcolm documentation enhancement New feature or request labels Nov 4, 2024
@mmguero mmguero added this to Malcolm Nov 5, 2024
@mmguero mmguero added the api Related to issues dealing with the Malcolm REST API label Nov 14, 2024
@mmguero mmguero self-assigned this Nov 14, 2024
@mmguero mmguero moved this to Testing in Malcolm Nov 14, 2024
@mmguero mmguero added this to the v24.11.0 milestone Nov 14, 2024
@mmguero mmguero changed the title add script for exporting dashboard add API for exporting dashboard Nov 14, 2024
mmguero added a commit to mmguero-dev/Malcolm that referenced this issue Nov 14, 2024
@mmguero mmguero closed this as completed Nov 14, 2024
@github-project-automation github-project-automation bot moved this from Testing to Done in Malcolm Nov 14, 2024
This was referenced Nov 14, 2024
@mmguero mmguero moved this from Done to Released in Malcolm Nov 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api Related to issues dealing with the Malcolm REST API dashboards Relating to Malcolm's OpenSearch Dashboards interface doc Relating to Malcolm documentation enhancement New feature or request
Projects
Status: Released
Development

No branches or pull requests

1 participant