Skip to content

monitor: describe SRE Agent diagrams in alt text and expand adoption guidance - #45

Merged
hellices merged 7 commits into
mainfrom
feature/sre-agent-image-alt-text
Aug 13, 2026
Merged

hellices merged 7 commits into
mainfrom
feature/sre-agent-image-alt-text

Conversation

@hellices

@hellices hellices commented Aug 13, 2026 •

Copy link
Copy Markdown
Owner

개요

Azure SRE Agent 소개 문서에서 공식 다이어그램 설명이 본문과 중복되던 부분을 정리하고, 도입 검토에 필요한 내용을 Microsoft Learn 기준으로 보강합니다. AI 작업 과정을 담고 있던 docs/ 폴더도 제거했습니다.

주요 변경 사항

이미지 설명 정리

공식 Microsoft Learn 다이어그램 5개의 설명을 본문 문단에서 이미지 대체 텍스트로 옮겼습니다. 같은 내용을 두 번 읽게 되는 구조를 없애면서 화면 낭독기 접근성도 개선했습니다.

문서 내용 보강

Microsoft Learn 문서를 조사해 도입 검토에 실제로 필요한 내용을 추가했습니다.

  • 사전 조건: 구독 등록, 필요한 권한, 리전 선택과 변경 불가 조건
  • 비용: Azure Agent Unit 기준 상시 비용과 활성 비용, 한도 동작
  • 보안: 샌드박스 실행, 단기 자격 증명, 데이터 보존 범위, Azure CLI 안전 장치
  • 자동화: 예약 작업, 심층 조사, 팀 지식 온보딩, Agent Hooks, 도구 용량 한도
  • 감사: customEvents 기반 활동 기록과 인시던트 지표
  • 확장: 스킬과 사용자 지정 에이전트의 차이, 동시 활성 스킬 한도
  • 배분: 대응 계획의 라우팅 조건과 계획별 실행 수준

또한 인시던트 플랫폼 연결 시 자동 생성되는 빠른 시작 대응 계획이 중복 처리를 일으킬 수 있다는 점을 점검 항목에 추가했습니다.

문서 구조 정리

  • docs/superpowers 폴더를 제거했습니다.
  • 실증 결과는 monitor/sre-agent-event-lab/validation-results.md로 옮겨 보존했습니다.
  • Dynamic Thresholds 지침은 monitor/sre-agent-event-lab/dynamic-thresholds.md로 옮겼습니다.
  • 관련 링크와 티켓·메일 아티팩트를 새 경로로 재생성했습니다.
  • 한국어 문체 참고 자료 섹션을 제거하고 제품 문서 링크를 목적별로 재구성했습니다.

이전 리뷰 후속 조치

  • 캡처 도구가 일시적인 네트워크 오류를 재시도하고, 연속 실패가 이어지면 명확한 오류로 종료합니다.
  • 스크립트가 Python 3.9에서도 동작하도록 형식 주석을 수정했습니다.
  • 렌더링 테스트 fixture가 실제로 Azure Monitor 경고 이벤트를 만들도록 수정했습니다.

검증

  • 79 passed
  • 모든 shell script bash -n 통과
  • capture_agent, capture_model, render_capture 모듈이 Python 3.9에서 정상 import
  • 네트워크 실패 5회 후 캡처가 명확한 오류로 종료하는 동작 확인
  • 브라우저 렌더링에서 이미지 10개 정상 표시, 공식 이미지 대체 텍스트 63~87자
  • 문서 상대 링크 깨짐 0건, docs/superpowers 참조 0건

hellices and others added 3 commits August 14, 2026 01:30
…n guidance

- Replace duplicated prose under official diagrams with descriptive alt text
- Drop the Korean localization style reference section
- Add prerequisites, pricing, security, automation, and audit sections from Microsoft Learn
- Warn about the default quickstart response plan conflict
- Treat network errors and timeouts as transient during evidence capture
- Fix the render timeline fixture so the alert event is sourced from Azure Monitor

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Remove the docs/superpowers workflow tree
- Keep the validation results and Dynamic Thresholds guidance inside the lab folder
- Repoint every reference and regenerate the ticket, email, and preview artifacts
- Restore Python 3.9 compatibility and report transient network failures
- Correct the permission, spending limit, VNet preview, and data processing statements

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Keep the processing-time caveat next to the reasoning diagram with a guard test
- Remove internal workflow directives from the relocated lab documents
- Stop the capture after repeated unreachable-endpoint failures
- Assert the rendered Mermaid handoff and detect any PEP 604 annotation

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the Azure SRE Agent documentation set to improve accessibility (moving diagram explanations into image alt text), expand adoption guidance (prereqs/cost/security/automation/audit), and remove the previously committed docs/ workflow artifacts while preserving lab validation evidence under monitor/sre-agent-event-lab/.

Changes:

  • Moved official diagram explanations from body prose into alt text and strengthened briefing content with adoption-critical topics and Learn references.
  • Relocated/renamed lab documents (validation results, dynamic thresholds) and updated all internal links/artifacts accordingly, with new tests to prevent regressions.
  • Improved capture script behavior for transient network failures and added/updated tests for rendering, privacy/link integrity, and notifications.

Reviewed changes

Copilot reviewed 27 out of 28 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
monitor/sre-agent-event-lab/validation-results.md Renames/relocates validation appendix and updates relative asset links.
monitor/sre-agent-event-lab/scripts/tests/test_render_capture.py Adds Mermaid handoff assertion and fixes timeline source labeling.
monitor/sre-agent-event-lab/scripts/tests/test_privacy.py Updates privacy/link checks and asserts removed workflow docs stay removed.
monitor/sre-agent-event-lab/scripts/tests/test_notifications.py Updates report URL in generated ticket/email assertions.
monitor/sre-agent-event-lab/scripts/tests/test_capture_agent.py Adds tests for transient network failures and Python 3.9-safe typing.
monitor/sre-agent-event-lab/scripts/tests/test_briefing_docs.py Enforces alt-text requirements and adoption-topic coverage in briefing.
monitor/sre-agent-event-lab/scripts/capture_agent.py Adds consecutive network failure handling and broadens TransientApiError typing.
monitor/sre-agent-event-lab/README.md Updates example report URL to the relocated validation results.
monitor/sre-agent-event-lab/dynamic-thresholds.md Reframes dynamic-thresholds doc for the new location and removes internal directives.
monitor/sre-agent-event-lab/assets/notifications/s1-incident-summary.html Updates embedded report path reference.
monitor/sre-agent-event-lab/assets/notifications/s1-incident-summary.eml Updates embedded report path reference and regenerates MIME boundary.
monitor/sre-agent-event-lab/assets/notifications/s1-github-issue.md Updates embedded report path reference.
monitor/azure-sre-agent.md Moves diagram descriptions into alt text and expands adoption guidance and references.
docs/superpowers/specs/2026-08-13-azure-sre-agent-official-images-design.md Deleted obsolete workflow/spec artifact.
docs/superpowers/specs/2026-08-13-azure-sre-agent-korean-briefing-redesign.md Deleted obsolete workflow/spec artifact.
docs/superpowers/specs/2026-08-12-azure-sre-agent-introduction-design.md Deleted obsolete workflow/spec artifact.
docs/superpowers/specs/2026-08-12-azure-sre-agent-evidence-capture-design.md Deleted obsolete workflow/spec artifact.
docs/superpowers/specs/2026-08-12-azure-sre-agent-event-testing-design.md Deleted obsolete workflow/spec artifact.
docs/superpowers/specs/2026-07-15-hdinsight-kafka-lag-scaled-test-design.md Deleted obsolete workflow/spec artifact.
docs/superpowers/plans/2026-08-13-azure-sre-agent-official-images.md Deleted obsolete workflow/plan artifact.
docs/superpowers/plans/2026-08-13-azure-sre-agent-korean-briefing-redesign.md Deleted obsolete workflow/plan artifact.
docs/superpowers/plans/2026-08-12-azure-sre-agent-introduction-execution.md Deleted obsolete workflow/plan artifact.
docs/superpowers/plans/2026-08-12-azure-sre-agent-evidence-capture-execution.md Deleted obsolete workflow/plan artifact.
docs/superpowers/plans/2026-08-12-azure-sre-agent-event-testing-execution.md Deleted obsolete workflow/plan artifact.
docs/superpowers/plans/2026-08-12-azure-monitor-dynamic-thresholds-sre-integration-execution.md Deleted obsolete workflow/plan artifact.
docs/superpowers/plans/2026-07-15-hdinsight-kafka-lag-scaled-test-execution.md Deleted obsolete workflow/plan artifact.
.azure/deployment-plan.md Updates pointers to relocated lab results documentation.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread monitor/sre-agent-event-lab/scripts/capture_agent.py
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 27 out of 28 changed files in this pull request and generated 1 comment.

Suppressed comments (2)

monitor/sre-agent-event-lab/scripts/tests/test_capture_agent.py:87

  • The test claims to verify that data_plane_get() sends the supplied bearer token, but it currently expects the Authorization header to be masked ("******"). This will fail once data_plane_get() correctly uses Bearer {token} and would also hide regressions where the header is wrong.
    assert result == {"value": []}
    assert observed == {
        "authorization": "Bearer actual-access-token",
        "timeout": 30,
    }

monitor/sre-agent-event-lab/scripts/tests/test_privacy.py:5

  • The module docstring still says the privacy scan leaves unrelated history (e.g. the HDInsight Kafka lag docs) untouched, but this suite now also asserts that docs/superpowers is removed. Updating the docstring to reflect the current scope will prevent confusion about what this test is intended to cover.
"""Regression guards for personal/internal identifiers introduced by the
Azure SRE Agent Event Lab branch.

Scope is intentionally limited to files added or modified for this lab so
that pre-existing, unrelated history (e.g. the HDInsight Kafka lag test

Comment thread monitor/sre-agent-event-lab/scripts/capture_agent.py
- Explain skills versus custom agents with the five active skill limit
- Describe response plan filters, per-plan autonomy, and disable behavior
- Mark managed connectors as preview

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 27 out of 28 changed files in this pull request and generated no new comments.

Suppressed comments (1)

monitor/sre-agent-event-lab/scripts/capture_agent.py:103

  • Retry-After can legally be an HTTP-date (not just seconds). int(exc.headers.get("Retry-After", "10")) will raise ValueError in that case, turning an otherwise transient 429/5xx response into an unexpected crash. Consider guarding the cast and falling back to a default retry delay when parsing fails.
        if exc.code == 429 or exc.code >= 500:
            retry_after = int(exc.headers.get("Retry-After", "10"))
            raise TransientApiError(retry_after, exc.code)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 27 out of 29 changed files in this pull request and generated no new comments.

Suppressed comments (1)

monitor/sre-agent-event-lab/scripts/capture_agent.py:95

  • data_plane_get() only calls reset_network_failures() after json.load(response) succeeds. If the endpoint is reachable but returns a non-JSON payload (or JSON decoding fails for any reason), the network-failure counter won't be reset even though connectivity was restored, and later transient network errors can be misclassified as the Nth consecutive failure.

Reset the counter immediately after a successful HTTP response is opened (before JSON decoding), and return the parsed payload directly from the try block so there is no fall-through state to manage.

    try:
        with urllib.request.urlopen(request, timeout=30) as response:
            payload = json.load(response)
    except urllib.error.HTTPError as exc:

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@hellices

Copy link
Copy Markdown
Owner Author

Addressed the suppressed suggestion from the latest review in a16349c.

data_plane_get() now calls reset_network_failures() immediately after the response opens and returns the parsed payload from inside the try block, so a reachable endpoint that returns a malformed body no longer leaves stale failure state. A regression test drives four network failures, then one non-JSON response, and asserts the next network failure is still transient. Full suite: 80 passed.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 27 out of 29 changed files in this pull request and generated no new comments.

@hellices
hellices merged commit 8b9e7b7 into main Aug 13, 2026
1 check passed
@hellices
hellices deleted the feature/sre-agent-image-alt-text branch August 13, 2026 17:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants