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

8984 Allow script log to be filtered #16446

Merged
merged 13 commits into from
Jul 1, 2024
11 changes: 11 additions & 0 deletions netbox/extras/constants.py
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
from extras.choices import LogLevelChoices

# Events
EVENT_CREATE = 'create'
EVENT_UPDATE = 'update'
Expand Down Expand Up @@ -135,3 +137,12 @@
}
},
]

LOG_LEVEL_RANK = {
LogLevelChoices.LOG_DEFAULT: 0,
LogLevelChoices.LOG_DEBUG: 1,
Comment on lines +142 to +143
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not clear on the distinction between debug and default: Debug is the lowest-ranked level, so shouldn't that be the default?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The existing LogLevelChoices has default defined so it needs to be mapped, we could filter and remove it from the dropdown but I included it because it is already existing. If we removed it from LogLevelChoices then we would need a migration script to convert old script runs to remove it.

LogLevelChoices.LOG_SUCCESS: 2,
LogLevelChoices.LOG_INFO: 3,
LogLevelChoices.LOG_WARNING: 4,
LogLevelChoices.LOG_FAILURE: 5,
}
53 changes: 32 additions & 21 deletions netbox/extras/views.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
from core.models import Job
from core.tables import JobTable
from dcim.models import Device, DeviceRole, Platform
from extras.choices import LogLevelChoices
from extras.dashboard.forms import DashboardWidgetAddForm, DashboardWidgetForm
from extras.dashboard.utils import get_widget_class
from netbox.constants import DEFAULT_ACTION_PERMISSIONS
Expand All @@ -30,6 +31,7 @@
from utilities.views import ContentTypePermissionRequiredMixin, get_viewname, register_model_view
from virtualization.models import VirtualMachine
from . import filtersets, forms, tables
from .constants import LOG_LEVEL_RANK
from .models import *
from .scripts import run_script
from .tables import ReportResultsTable, ScriptResultsTable
Expand Down Expand Up @@ -1119,22 +1121,27 @@ def get_table(self, job, request, bulk_actions=True):
tests = None
table = None
index = 0

log_threshold = LOG_LEVEL_RANK.get(request.GET.get('log_threshold', LogLevelChoices.LOG_DEFAULT))
if job.data:

if 'log' in job.data:
if 'tests' in job.data:
tests = job.data['tests']

for log in job.data['log']:
index += 1
result = {
'index': index,
'time': log.get('time'),
'status': log.get('status'),
'message': log.get('message'),
'object': log.get('obj'),
'url': log.get('url'),
}
data.append(result)
log_level = LOG_LEVEL_RANK.get(log.get('status'), LogLevelChoices.LOG_DEFAULT)
if log_level >= log_threshold:
index += 1
result = {
'index': index,
'time': log.get('time'),
'status': log.get('status'),
'message': log.get('message'),
'object': log.get('obj'),
'url': log.get('url'),
}
data.append(result)

table = ScriptResultsTable(data, user=request.user)
table.configure(request)
Expand All @@ -1146,17 +1153,19 @@ def get_table(self, job, request, bulk_actions=True):
for method, test_data in tests.items():
if 'log' in test_data:
for time, status, obj, url, message in test_data['log']:
index += 1
result = {
'index': index,
'method': method,
'time': time,
'status': status,
'object': obj,
'url': url,
'message': message,
}
data.append(result)
log_level = LOG_LEVEL_RANK.get(status, LogLevelChoices.LOG_DEFAULT)
if log_level >= log_threshold:
index += 1
result = {
'index': index,
'method': method,
'time': time,
'status': status,
'object': obj,
'url': url,
'message': message,
}
data.append(result)

table = ReportResultsTable(data, user=request.user)
table.configure(request)
Expand All @@ -1174,6 +1183,8 @@ def get(self, request, **kwargs):
'script': job.object,
'job': job,
'table': table,
'log_levels': dict(LogLevelChoices),
'log_threshold': request.GET.get('log_threshold', LogLevelChoices.LOG_DEFAULT)
}

if job.data and 'log' in job.data:
Expand Down
22 changes: 20 additions & 2 deletions netbox/templates/extras/script_result.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,26 @@
<div class="tab-pane show active" id="results" role="tabpanel" aria-labelledby="results-tab">

{# Object table controls #}
<div class="row mb-3">
<div class="col-auto ms-auto d-print-none">
<div class="d-flex align-items-center mb-3">
<div>{% trans "Log threshold" %}</div>

<div class="px-2 d-print-none">
<div class="dropdown">
<button class="btn btn-outline-secondary dropdown-toggle" type="button" data-bs-toggle="dropdown" aria-expanded="false">
{{ log_levels|get_key:log_threshold }}
</button>
<div class="dropdown-menu">
{% for level, name in log_levels.items %}
<a class="dropdown-item d-flex justify-content-between" href="{% url 'extras:script_result' job_pk=job.pk %}?log_threshold={{ level }}">
{{ name }}
{% if level == log_threshold %}<span class="badge bg-green ms-auto"></span>{% endif %}
</a>
{% endfor %}
</div>
</div>
</div>

<div class="ms-auto d-print-none">
{% if request.user.is_authenticated and job.completed %}
<div class="table-configure input-group">
<button type="button" data-bs-toggle="modal" title="{% trans "Configure Table" %}" data-bs-target="#ObjectTable_config"
Expand Down