Skip to content

adds Azure Logs docs. #189

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions docs/modules/azure_logs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Azure Logs

Displays results from an Azure - Log Analytics Workspace query.

## Configuration

```yaml
azurelogs:
title: web request stats
enabled: true
queryFile: "queries/web_stats.yaml"
position:
top: 2
left: 0
height: 1
width: 1
refreshInterval: 30
```

example query file `queries/web_stats.yaml`:

```yaml
azure_subscription_id: 6a258992-8b46-4657-ae2f-1384f2c94af1
azure_workspace_id: 0f244ff4-ddd1-468e-8587-933a54a1ef07
columns: ["method", "status", "count"]
Copy link
Preview

Copilot AI Jul 14, 2025

Choose a reason for hiding this comment

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

These column names don’t match the fields output by the sample query (RequestCount, HTTPMethod, StatusCode); update to ["HTTPMethod", "StatusCode", "RequestCount"] or adjust the query accordingly.

Suggested change
columns: ["method", "status", "count"]
columns: ["HTTPMethod", "StatusCode", "RequestCount"]

Copilot uses AI. Check for mistakes.

query: |
AzureDiagnostics
| where Category == "FrontdoorAccessLog"
| where TimeGenerated > ago(10m)
| summarize RequestCount = count() by HTTPMethod = httpMethod_s, StatusCode = httpStatusCode_s
| top 12 by RequestCount
```

## Screenshots

<img class="screenshot" src="/assets/modules/azure_logs.png" width="245" height="254" alt="Azure Logs screenshot" />

## Attributes

<table>
{% include "attributes/table_header.md" %}

<tbody>
{% with name="title", desc="Title to display above the results", value="" %}
{% include "attributes/custom.md" %}
{% endwith %}

{% with name="queryFile", desc="Path to file containing the kusto query", value="." %}
{% include "attributes/custom.md" %}
{% endwith %}
</tbody>
</table>

{% set src="azurelogs" %}
{% include "src_path.md" %}
Binary file added docs/overrides/assets/modules/azure_logs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ nav:
- Airbrake: modules/airbrake.md
- Asana: modules/asana.md
- Azure DevOps: modules/azure_devops.md
- Azure Logs: modules/azure_logs.md
- BambooHR: modules/bamboohr.md
- Bargraph: modules/bargraph.md
- BuildKite: modules/buildkite.md
Expand Down
Binary file added site/assets/modules/azure_logs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.