dashboards-migrator

Description

Dashboards migrator is a CLI tool for migrating dashboards from Logmanager 3 to Logmanager 4.

How it works

Dashboards migrator takes a dashboard exported from LM3 as input, iterates over its contents and migrates it to version compliant with LM4.

You need to provide an input path to exported LM3 dashboard and output path to which dashboards migrator will write LM4 dashboard. Output file generated from dashboard migrator is ready to be imported to LM4.

If you want LM4 dashboard to be targetting specific index-pattern you can provide it by using -ip flag but it's not mandatory - index-pattern can also be assigned during dashboard import.

Disclaimer

While Dashboards migrator should be able to deal with most common use cases effectively, there is a possibility that more complicated dashboards might not be migrated fully or with errors! Always make sure to import and test your migrated dashboard to make sure it works as expected.

Please make sure to report any errors you encounter so we can improve dashboards migrator functionality.

Usage

Usage of ./dashboards-migrator:
  -h
        Print help
  -i string
        Path to input file containing LM3 dashboard (Mandatory)
  -ip string
        Index-pattern string (Default: empty)
  -o string
        Path to output file containing LM4 dashboard (Mandatory)

If you used ip flag you need to make sure before importing your migrated dashboard that related index and index-pattern exists.

Examples:

1. Read LM3 dashboard from log-overview.json file, set index-pattern to lm-* and output migration results to log-overview.ndjson

./dashboards-migrator -i log-overview.json -o log-overview.ndjson -ip lm-*

Development

A Makefile is provided for common development tasks:

make build   # Build the binary
make test    # Run tests with race detector
make lint    # Run golangci-lint
make vuln    # Run vulnerability check
make clean   # Remove built binary

Prerequisites

• Go 1.24+
• golangci-lint (for linting)
• govulncheck (for vulnerability checking)

Release

Go to: https://github.com/logmanager-oss/dashboards-migrator/releases to grab latest version of Dashboards Migrator. It is available for Windows, Linux and MacOS (x86_64/Arm64).

We are using Goreleaser for building Dashboards Migrator release files.

If you wish to create your own build:

1. Clone the repository
2. Run make build or CGO_ENABLED=0 GOOS=<your_target_OS> GOARCH=<your_target_CPU_architecture> go build -o <filename> ./cmd/main.go

You can also install Dashboard Migrator to your system by running:

go install github.com/logmanager-oss/dashboards-migrator@latest