Skip to content

Commit

Permalink
Merge pull request #50 from valiton/release/v3.0.1
Browse files Browse the repository at this point in the history
Release/v3.0.1
  • Loading branch information
CapChrisCap authored Aug 27, 2021
2 parents f23efb0 + 7b32a0f commit 80e3364
Show file tree
Hide file tree
Showing 4 changed files with 23 additions and 13 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ artifacts/
work/
ci/
e2e-results/
valiton-mongodbatlas-datasource/

# Editor
.idea
27 changes: 18 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ MongoDB Atlas allows to fetch logs from their service. More information can be f

This plugin allows to fetch [process](https://docs.atlas.mongodb.com/reference/api/process-measurements/), [database](https://docs.atlas.mongodb.com/reference/api/process-databases-measurements/) and [disk](https://docs.atlas.mongodb.com/reference/api/process-disks-measurements/) logs from MongoDB Atlas in your Grafana dashboard. This allows you to monitor your whole MongoDB Atlas infrastructure within your grafana dashboards.

![Panel Example](./src/img/screenshots/query_example.png)
![Panel Example](https://raw.githubusercontent.com/valiton/grafana-mongodb-atlas-datasource/master/src/img/screenshots/query_example.png)

## Installation

Expand All @@ -13,14 +13,14 @@ This plugin allows to fetch [process](https://docs.atlas.mongodb.com/reference/a
You can load the latest plugin version with the following command:

```bash
grafana-cli --pluginUrl https://github.com/valiton/grafana-mongodb-atlas-datasource/releases/v3.0.0/download/valiton-mongodb-atlas-datasource.zip plugins install valiton-mongodbatlas-datasource
grafana-cli --pluginUrl https://github.com/valiton/grafana-mongodb-atlas-datasource/releases/v3.0.1/download/valiton-mongodbatlas-datasource.zip plugins install valiton-mongodbatlas-datasource
```

For docker setup add the following environment variable to automatically install the plugin:

```bash
docker run -p 3000:3000 \
-e GF_INSTALL_PLUGINS="https://github.com/valiton/grafana-mongodb-atlas-datasource/releases/download/v3.0.0/valiton-mongodb-atlas-datasource.zip;valiton-mongodb-atlas-datasource" \
-e GF_INSTALL_PLUGINS="https://github.com/valiton/grafana-mongodb-atlas-datasource/releases/download/v3.0.1/valiton-mongodb-atlas-datasource.zip;valiton-mongodbatlas-datasource" \
-e "GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS=valiton-mongodbatlas-datasource" \
grafana/grafana:8.0.0
```
Expand All @@ -35,11 +35,11 @@ For more information about the plugin installation have a look at the [plugin of

After installing the datasource in Grafana (see Grafana Setup section), you can create a Grafana datasource.

![Select MongoDB Atlas Logs datasource from list](./src/img/screenshots/datasource_list.png)
![Select MongoDB Atlas Logs datasource from list](https://raw.githubusercontent.com/valiton/grafana-mongodb-atlas-datasource/master/src/img/screenshots/datasource_list.png)

Please enter here your programmatic API key credentials in the two input fields and click on enter. If the credentials are valid, you will see a green info box. For more information, have a look at the [MongoDB Atlas documentation](https://docs.atlas.mongodb.com/configure-api-access/#programmatic-api-keys) to create these credentials.

![Enter your MongoDB Atlas credentials to the form](./src/img/screenshots/datasource_setup.png)
![Enter your MongoDB Atlas credentials to the form](https://raw.githubusercontent.com/valiton/grafana-mongodb-atlas-datasource/master/src/img/screenshots/datasource_setup.png)

## Create Panel

Expand All @@ -51,7 +51,7 @@ After setting up the datasource, you are able to create a query for a Grafana pa

Next, you are asked different other parameters, such as the database name and then you can select the dimension you want to display in the query. To name the query, please use the `alias` input. You can use `{{name}}` to use metrics or dimensions for the name (see hint field of `alias` for more information).

![Enter parameters for your MongoDB Atlas Query](./src/img/screenshots/query_setup.png)
![Enter parameters for your MongoDB Atlas Query](https://raw.githubusercontent.com/valiton/grafana-mongodb-atlas-datasource/master/src/img/screenshots/query_setup.png)

# Dev setup

Expand Down Expand Up @@ -125,7 +125,16 @@ Pull requests for new features, bug fixes, and suggestions are welcome!
yarn install
npm run build
mage -v
zip -r valiton-mongodb-atlas-datasource.zip ./dist
rm -Rf valiton-mongodbatlas-datasource && \
cp -R dist valiton-mongodbatlas-datasource
```

Next, please remove all dev-related topics from the `valiton-mongodbatlas-datasource/README.md` file. Otherwise, we can not publish it as Grafana plugin (only keep introduction & usage section).

Next, bundle it as

```bash
zip -r valiton-mongodbatlas-datasource.zip ./valiton-mongodbatlas-datasource
```

**5. Create Release with zip files as attachment**
Expand All @@ -134,11 +143,11 @@ see https://help.github.com/en/articles/creating-releases for more information

# Changelog

[Changelog](./CHANGELOG.md)
[Changelog](https://github.com/valiton/grafana-mongodb-atlas-datasource/blob/master/CHANGELOG.md)

# License

[MIT](./LICENSE.txt)
[MIT](https://github.com/valiton/grafana-mongodb-atlas-datasource/blob/master/LICENSE)

# Thanks to

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "valiton-valiton-mongodbatlas-datasource",
"version": "3.0.0",
"version": "3.0.1",
"description": "Display MongoDB Atlas metrics inside of Grafana",
"scripts": {
"build": "grafana-toolkit plugin:build",
Expand Down
6 changes: 3 additions & 3 deletions src/plugin.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,15 @@
"screenshots": [
{
"name": "Setup",
"path": "./img/screenshots/datasource_setup.png"
"path": "img/screenshots/datasource_setup.png"
},
{
"name": "Query Example",
"path": "./img/screenshots/query_example.png"
"path": "img/screenshots/query_example.png"
},
{
"name": "Query Options",
"path": "./img/screenshots/query_setup.png"
"path": "img/screenshots/query_setup.png"
}
],
"version": "%VERSION%",
Expand Down

0 comments on commit 80e3364

Please sign in to comment.