1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
|
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------
"""
FILE: sample_custom_error_callback.py
DESCRIPTION:
This sample demonstrates how to use error callbacks to customize how errors are handled during upload.
Note: This sample requires the azure-identity library.
USAGE:
python sample_custom_error_callback.py
Set the environment variables with your own values before running the sample:
1) DATA_COLLECTION_ENDPOINT - your data collection endpoint
2) LOGS_DCR_RULE_ID - your data collection rule immutable ID
3) LOGS_DCR_STREAM_NAME - your data collection rule stream name
If using an application service principal for authentication, set the following:
1) AZURE_TENANT_ID - your Azure AD tenant (directory) ID
2) AZURE_CLIENT_ID - your Azure AD client (application) ID
3) AZURE_CLIENT_SECRET - your Azure AD client secret
"""
import os
from typing import List, MutableMapping, cast
from azure.core.exceptions import HttpResponseError
from azure.identity import DefaultAzureCredential
from azure.monitor.ingestion import LogsIngestionClient, LogsUploadError
endpoint = os.environ["DATA_COLLECTION_ENDPOINT"]
credential = DefaultAzureCredential()
client = LogsIngestionClient(endpoint=endpoint, credential=credential, logging_enable=True)
rule_id = os.environ["LOGS_DCR_RULE_ID"]
body: List[MutableMapping[str, str]] = [
{"Time": "2021-12-08T23:51:14.1104269Z", "Computer": "Computer1", "AdditionalContext": "context-2"},
{"Time": "2021-12-08T23:51:14.1104269Z", "Computer": "Computer2", "AdditionalContext": "context"},
]
failed_logs: List[MutableMapping[str, str]] = []
# Sample callback that stores the logs that failed to upload.
def on_error_save(error: LogsUploadError) -> None:
print("Log chunk failed to upload with error: ", error.error)
failed_logs.extend(cast(List[MutableMapping[str, str]], error.failed_logs))
# Sample callback that just ignores the error.
def on_error_pass(_) -> None:
pass
# Sample callback that raises the error if it corresponds to a specific HTTP error code.
# This aborts the rest of the upload.
def on_error_abort(error: LogsUploadError) -> None:
if isinstance(error.error, HttpResponseError):
if cast(HttpResponseError, error.error).status_code in (400, 401, 403):
print("Aborting upload...")
raise error.error
client.upload(rule_id=rule_id, stream_name=os.environ["LOGS_DCR_STREAM_NAME"], logs=body, on_error=on_error_save)
# Retry once with any failed logs, and this time ignore any errors.
if failed_logs:
print("Retrying logs that failed to upload...")
client.upload(
rule_id=rule_id, stream_name=os.environ["LOGS_DCR_STREAM_NAME"], logs=failed_logs, on_error=on_error_pass
)
|
