Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/promlabs/promlens-public
Public repository for PromLens documentation, issues, bugs, and feature requests
https://github.com/promlabs/promlens-public
Last synced: 10 days ago
JSON representation
Public repository for PromLens documentation, issues, bugs, and feature requests
- Host: GitHub
- URL: https://github.com/promlabs/promlens-public
- Owner: promlabs
- Created: 2020-06-29T05:27:38.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-11-08T06:40:39.000Z (about 2 years ago)
- Last Synced: 2024-08-02T15:55:17.368Z (4 months ago)
- Homepage:
- Size: 35.2 KB
- Stars: 147
- Watchers: 4
- Forks: 10
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# PromLens
**NOTE: This repository documents the former commercial version of PromLens. PromLens has since been open-sourced to the Prometheus project and now lives at https://github.com/prometheus/promlens. PromLens is now free for anyone to use without a license key!**
This repository contains documentation and public issues and feature requests for the [PromLens PromQL query builder, analyzer, and visualizer](https://promlens.com/).
## Reporting issues
Please file issues on the [GitHub issue tracker](https://github.com/promlabs/promlens-public/issues).
## Running PromLens
The following documents how to run PromLens yourself using the [official Docker image](https://hub.docker.com/r/promlabs/promlens).
### Example deployment
To run PromLens as a preview version without a license key, and with commercial features (link sharing, Grafana integration, etc.) disabled:
```
docker run -p 8080:8080 promlabs/promlens
```
To run PromLens with a license key, and with link sharing and Grafana integration enabled, using SQLite for link sharing:
```
docker run -p 8080:8080 promlabs/promlens \
--license.key=$LICENSE_KEY \
--shared-links.sql.driver=sqlite3 \
--shared-links.sql.dsn=/tmp/promlens-links.db \
--grafana.url=$GRAFANA_URL \
--grafana.api-token=$GRAFANA_API_TOKEN
```
Then head to http://localhost:8080/ to see the PromLens web UI.
### Flags
The `promlens` binary in the Docker image has the following flags:
```
./promlens --help
usage: promlens []
The PromLens server
Flags:
-h, --help Show context-sensitive help (also try --help-long and --help-man).
--license.key="" License key for PromLens (set either this or --license.key-file).
--license.key-file="" Path to a file containing the license key for PromLens (set either this or --license.key).
--shared-links.gcs.bucket=""
Name of the GCS bucket for storing shared links. Set the GOOGLE_APPLICATION_CREDENTIALS environment variable to point to the JSON file defining your service account credentials (needs to have permission to create, delete, and view objects in the provided bucket).
--shared-links.sql.driver=""
The SQL driver to use for storing shared links in a SQL database. Supported values: [mysql, sqlite3].
--shared-links.sql.dsn="" SQL Data Source Name when using a SQL database to shared links (see https://github.com/go-sql-driver/mysql#dsn-data-source-name) for MySQL, https://github.com/mattn/go-sqlite3#dsn-examples for SQLite3). Alternatively, use the environment variable PROMLENS_SHARED_LINKS_DSN to indicate this value.
--shared-links.sql.create-tables
Whether to automatically create the required tables when using a SQL database for shared links.
--shared-links.sql.retention=0
The maximum retention time for shared links when using a SQL database (e.g. '10m', '12h', '30d'). Set to 0 for infinite retention.
--grafana.url="" The URL of your Grafana installation, to enable the Grafana datasource selector.
--grafana.api-token="" The auth token to pass to the Grafana API.
--grafana.api-token-file=""
A file containing the auth token to pass to the Grafana API.
--grafana.default-datasource-id=0
The default Grafana datasource ID to use (overrides Grafana's own default).
--web.listen-address=":8080"
The address to listen on for the web API.
--web.external-url="" The URL under which PromLens is externally reachable (for example, if PromLens is served via a reverse proxy). Used for generating relative and absolute links back to PromLens itself. If the URL has a path portion, it will be used to prefix all HTTP endpoints served by PromLens. If omitted, relevant URL components will be derived automatically.
--web.route-prefix="" Prefix for the internal routes of web endpoints. Defaults to path of --web.external-url.
--web.default-prometheus-url=""
The default Prometheus URL to load PromLens with.
--log.level=info Only log messages with the given severity or above. One of: [debug, info, warn, error]
--log.format=logfmt Output format of log messages. One of: [logfmt, json]
```
For boolean flags that default to `true`, you can set them to `false` by specifying `--no-`, e.g. `--no-shared-links.sql.create-tables`.
### Providing a license key (OPTIONAL, for non-free features)
To enable non-free PromLens features such as the Grafana datasource selector and link sharing, you will need to provide a license key. If you are interested in a trial license key, please just ask for one at [email protected] or sign up at https://promlens.com/pricing.
To start PromLens with the license key provided directly as a flag value:
```
docker run -p 8080:8080 promlabs/promlens --license.key=$LICENSE_KEY
```
Alternatively, you can provide the license key in a file:
```
docker run -p 8080:8080 promlabs/promlens --license.key-file=$LICENSE_KEY_FILE
```
### Enabling link sharing
**NOTE:** Link sharing requires a valid PromLens license key.
Link sharing allows persisting the state of an entire PromLens query page and sharing it with others.
By default, the link sharing backend is disabled. You can enable link sharing either via Google Cloud Storage, MySQL, or SQLite3:
#### Google Cloud Storage
To use Google Cloud Storage (GCS) for link sharing, set the `--shared-links.gcs.bucket=` flag and set the `GOOGLE_APPLICATION_CREDENTIALS` environment variable to point to a JSON file containing your service account credentials (needs to have permission to create, delete, and view objects in the provided bucket).
#### SQlite3
To save shared links to a local SQLite3 database, set the `--shared-links.sql.driver=sqlite3` and `--shared-links.sql.dsn=` flags.
#### MySQL
To save shared links in a MySQL database, set the `--shared-links.sql.driver=mysql` and `--shared-links.sql.dsn=` flag (see https://github.com/go-sql-driver/mysql#dsn-data-source-name for MySQL DNS specifications).
By default, PromLens will try to auto-create the necessary tables in your MySQL database. This requires the PromLens database user to have `CREATE` permissions. To turn off automatic table creation for MySQL, set the `--no-shared-links.sql.create-tables` flag. If you want to create tables manually, run the following against your PromLens MySQL database:
```sql
CREATE TABLE IF NOT EXISTS link (
id INT AUTO_INCREMENT PRIMARY KEY,
created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
short_name VARCHAR(11) UNIQUE,
page_state TEXT
);
CREATE TABLE IF NOT EXISTS view(
id INT AUTO_INCREMENT PRIMARY KEY,
link_id INTEGER,
viewed_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
FOREIGN KEY(link_id) REFERENCES link(id)
);
```
### Enabling Grafana datasource integration
**NOTE:** Grafana datasource integration requires a valid PromLens license key.
To enable selection of datasources from an existing Grafana installation, set the `--grafana.url` flag to the URL of your Grafana installation, as well as either the `--grafana.api-token` flag (providing an API token directly as a flag) or the `--grafana.api-token-file` flag (providing an API token from a file).
#### Creating a Grafana API token
To create an API token suitable for looking up datasources in Grafana:
- Head to "Configuration > API Keys" in Grafana.
- Click "Add API key".
- Give the key a descriptive name, set the "Role" to "Admin", and set its life time to the desired duration (long is recommended, as you will need to regenerate it frequently otherwise).
- Press "Add" and note down the displayed API key.
### Direct links to queries
If you have a valid license key, you can link to a specific query without creating a persisted shared link, by appending a `q` query parameter to the PromLens URL. For example, https://promlens.com/?q=up directly displays and executes the query `up`. For more complex shared pages, we still recommend creating a full shared page link, as this allows more control over the tree view state, as well as the selected visualization methods.
### Architecture
Depending on whether you enable commercial features with a license, the PromLens backend has fewer or more responsibilities:
#### Preview features
When running the preview version of PromLens without a license key, the backend is only used to serve static assets and parse PromQL queries into a tree view:
#### Full features (with license)
If you enable link sharing and/or Grafana datasource integration when using PromLens with a license key, the backend also stores and retrieves shared links and connects to Grafana to list datasources and proxy queries:
