Skip to content

Commit

Permalink
Fix graylog dashboard (#359)
Browse files Browse the repository at this point in the history 
* Fix graylog dashboard error search term

* Remove deprecated dashboard and remove script update dashboard by API. We use only content packs

* Document exclusive usage of content packs

* Remove fully configure_dashboards
  • Loading branch information
@YuryHrytsuk
YuryHrytsuk authored Sep 20, 2023
1 parent fdc154e commit 5590f18
Show file tree
Hide file tree
Showing 5 changed files with 4 additions and 413 deletions.
3 changes: 2 additions & 1 deletion services/graylog/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ make down
1. Create a GELF UDP INPUT
2. Show incoming messages
3. All the docker container messages shall be visible
4. Send a message following through the console:
4. Use *content packs* to preconfigure dashboards, alerts, pipelines, ...
5. Send a message following through the console:

```console
echo -n '{ "version": "1.1", "host": "example.org", "short_message": "A short message", "level": 5, "_some_info": "foo" }' | nc -w0 -u localhost 12201
Expand Down
2 changes: 1 addition & 1 deletion services/graylog/data/contentpacks/osparc-custom-content-pack-v2.json
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"v": "1",
"id": "dfaeea11-bde6-4203-9cfe-6ca2a23ca22e",
"rev": 40,
"rev": 41,
"name": "osparc-custom-content-pack-v2",
"summary": "osparc-custom-content-pack-v2",
"description": "",
Expand Down
1 change: 1 addition & 0 deletions services/graylog/scripts/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# Purpose

This python scripts check if Graylog is running, and add the necessary inputs if the Graylos instance is a new one..
**Nota bene**: Use content packs to preconfigure dashboards, ...

# Installation

Expand Down
138 changes: 0 additions & 138 deletions services/graylog/scripts/configure.py
View file
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
import copy
import json
import logging
import os
import random
import uuid
import warnings
from time import sleep

Expand Down Expand Up @@ -351,138 +348,6 @@ def configure_alerts():
exit(1)


def configure_dashboards():
print("Configuring Graylog Dashboards...")
with open("dashboards.yaml") as f:
data = yaml.load(f, Loader=SafeLoader)
url = (
"https://monitoring."
+ env.str("MACHINE_FQDN")
+ "/graylog/api/dashboards?query=&page=1&per_page=10&sort=title&order=asc"
)
r = session.get(url, headers=hed)
if r.status_code == 200:
totalDashboards = r.json()["total"]
totalDashboards = int(totalDashboards)
alreadyPresentDashboards = r.json()
url = "https://monitoring." + env.str("MACHINE_FQDN") + "/graylog/api/views"
for presentDashboard in alreadyPresentDashboards["elements"]:
resp = session.delete(
url + "/" + str(presentDashboard["id"]), headers=hed, verify=False
)
if resp.ok:
print(
"Dashboard successfully deleted: "
+ str(presentDashboard["title"])
)
else:
print(
"Could not delete a Dashboard. Failure: "
+ str(resp.status_code)
+ "!"
)
print(resp.json())
exit(1)
else:
print(
"Could not fetch dashboards. Is graylog misconfigured? Exiting with error!"
)
exit(1)

for i in data:
url = (
"https://monitoring."
+ env.str("MACHINE_FQDN")
+ "/graylog/api/views/search"
)
randSearchid = "".join(random.choice("0123456789abcdef") for n in range(24))
randUuid = str(uuid.uuid4())
print(randSearchid, randUuid)
content = {
"id": randSearchid,
"queries": [
{
"id": randUuid,
"query": {"type": "elasticsearch", "query_string": ""},
"timerange": {"type": "relative", "from": 300},
"search_types": [],
}
],
"parameters": [],
}
resp = session.post(url, headers=hed, json=content)
if resp.status_code == 201:
print("Search successfully added. ")
else:
print("Could not add search. Failure:", resp.status_code)
print(resp.json())
exit(1)
url = (
"https://monitoring."
+ env.str("MACHINE_FQDN")
+ "/graylog/api/views/search/"
+ str(randSearchid)
+ "/execute"
)
resp = session.post(url, headers=hed)
if resp.status_code == 201:
print("Search successfully executed. ")
else:
print("Could not execute search. Failure:", resp.status_code)
print(resp.json())
exit(1)
####
url = (
"https://monitoring."
+ env.str("MACHINE_FQDN")
+ "/graylog/api/views/search/metadata"
)
content = {
"id": randSearchid,
"queries": [
{
"id": curQuery["id"],
"query": curQuery["query"],
"timerange": curQuery["timerange"],
"filter": None,
"search_types": [],
}
for curQuery in i["state"][list(i["state"].keys())[0]]["widgets"]
],
"parameters": [],
}
resp = session.post(url, headers=hed, json=content)
if resp.status_code == 200:
print("Search metadata executed. ")
else:
print("Could not add metadata for search. Failure:", resp.status_code)
print(resp.json())
exit(1)
####
url = "https://monitoring." + env.str("MACHINE_FQDN") + "/graylog/api/views"
i["search_id"] = str(randSearchid)
uuidInFile = list(i["state"].keys())[0]
i["state"][randUuid] = copy.deepcopy(i["state"][uuidInFile])
del i["state"][uuidInFile]
del i["state"][randUuid]["widget_mapping"]
i["state"][randUuid]["widget_mapping"] = {}
resp = session.post(url, headers=hed, json=i)
if resp.status_code == 200:
print("Dashboard successfully added: " + str(i["title"]))
else:
print("Could not add dashboard. Failure:", resp.status_code)
print(resp.json())
exit(1)
print("###################################")
print("WARNING: CURRENTLY THERE IS A MINOR BUG W.R.T. DASHBOARDS, PLEASE READ:")
print(
"Graylog dashboards will be empty, you need to open the dashboard, go to a widget, and modify the graylog search query"
)
print("[Such as: Remove & Re-Add a single letter]")
print("Then, the dashboard will work. Make sure to save it.")
print("###################################")


def configure_content_packs(session, headers, base_url):
def get_installation(content_pack):
logger.debug(f"Getting installations for content pack {content_pack['id']}")
Expand Down Expand Up @@ -617,9 +482,6 @@ def install_content_pack_revision(content_pack):
# Configure Alerts
configure_alerts()

# Configure Dashboards
configure_dashboards()

# content pack will create GELF UDP Input
# NOTE: When you introduce changes, revision number increase is mandatory
# we cannot use auto loader since it doesn't properly update content packs.
Expand Down
Loading

0 comments on commit 5590f18

Please sign in to comment.