OBSDOCS-3375: Document Azure Logs Ingestion API#112606
Open
johnwilkins wants to merge 1 commit into
Open
Conversation
Add documentation for the azureLogsIngestion output type, which uses
the Azure Monitor Logs Ingestion API with Data Collection Rules (DCR).
This replaces the deprecated azureMonitor output type that uses the
Data Collector API being disabled by Microsoft on September 14, 2026.
New modules:
- about-azure-logs-ingestion-api.adoc: Overview of new API advantages
- azure-logs-ingestion-dcr-requirements.adoc: DCR prerequisites intro
- azure-dcr-components.adoc: DCR component details
- azure-dcr-required-information.adoc: Required DCR information reference
- azure-dcr-authentication-permissions.adoc: DCR permissions concept
- azure-logs-ingestion-authentication.adoc: Authentication methods intro
- azure-auth-client-secret.adoc: Client secret authentication concept
- azure-auth-workload-identity.adoc: Workload identity concept
- azure-auth-permissions.adoc: Authentication permissions concept
- logging-forwarding-azure-logs-ingestion.adoc: Configuration procedure
with examples for clientSecret, workloadIdentity, and custom timestamp
Updated modules:
- clf-outputs-reference.adoc: Add azureLogsIngestion output type
- configuring-log-forwarding.adoc: Include new Azure modules
Structure:
- Concepts introduce topics before procedures
- No level 2 headings in modules (split into submodules with leveloffset)
- No DITA-incompatible callouts (replaced with explanatory text)
- Use Red Hat attributes ({product-title}, {clo}, {oc-first})
- AsciiDocDITA compliant (related-links, block titles, em dashes)
Both azureLogsIngestion and azureMonitor outputs coexist until
September 2026 to allow customer migration.
Engineering Jira: OBSDA-804
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
openshift-ci-robot
added
the
jira/valid-reference
|
@johnwilkins: This pull request references OBSDOCS-3375 which is a valid jira issue. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
openshift-ci
Bot
added
the
size/L
|
🤖 Mon Jun 01 21:18:23 - Prow CI generated the docs preview: |
|
@johnwilkins: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds documentation for the new
azureLogsIngestionoutput type, which uses the Azure Monitor Logs Ingestion API with Data Collection Rules (DCR). This replaces the deprecatedazureMonitoroutput type.Critical deadline: Microsoft is disabling the old Data Collector API on September 14, 2026. Customers using the legacy
azureMonitoroutput must migrate before this date.Changes
New modules (10):
about-azure-logs-ingestion-api.adoc- Overview of new API and advantagesazure-logs-ingestion-dcr-requirements.adoc- DCR prerequisites introazure-dcr-components.adoc- DCR component detailsazure-dcr-required-information.adoc- Required DCR informationazure-dcr-authentication-permissions.adoc- DCR permissionsazure-logs-ingestion-authentication.adoc- Authentication methods introazure-auth-client-secret.adoc- Client secret authenticationazure-auth-workload-identity.adoc- Workload identity authenticationazure-auth-permissions.adoc- Authentication permissionslogging-forwarding-azure-logs-ingestion.adoc- Configuration procedure with examplesUpdated modules (2):
clf-outputs-reference.adoc- AddedazureLogsIngestionoutput typeconfiguring-log-forwarding.adoc- Included new Azure modulesDocumentation structure
leveloffset=+3){product-title},{clo},{oc-first})Examples provided
Engineering context
Both
azureLogsIngestionandazureMonitoroutputs coexist in documentation to support customer migration through September 2026.Testing
Preview:
Version: 6.6
Signed-off-by: John Wilkins jowilkin@redhat.com