# Input plugin to collect Windows Event Log messages [[inputs.win_eventlog]] ## Telegraf should have Administrator permissions to subscribe for some Windows Events channels ## (System log, for example) ## LCID (Locale ID) for event rendering ## 1033 to force English language ## 0 to use default Windows locale # locale = 0 ## Name of eventlog, used only if xpath_query is empty ## Example: "Application" # eventlog_name = "" ## xpath_query can be in defined short form like "Event/System[EventID=999]" ## or you can form a XML Query. Refer to the Consuming Events article: ## https://docs.microsoft.com/en-us/windows/win32/wes/consuming-events ## XML query is the recommended form, because it is most flexible ## You can create or debug XML Query by creating Custom View in Windows Event Viewer ## and then copying resulting XML here xpath_query = ''' *[System[( (EventID >= 5152 and EventID <= 5158) or EventID=5379 or EventID=4672)]] ''' ## System field names: ## "Source", "EventID", "Version", "Level", "Task", "Opcode", "Keywords", "TimeCreated", ## "EventRecordID", "ActivityID", "RelatedActivityID", "ProcessID", "ThreadID", "ProcessName", ## "Channel", "Computer", "UserID", "UserName", "Message", "LevelText", "TaskText", "OpcodeText" ## In addition to System, Data fields can be unrolled from additional XML nodes in event. ## Human-readable representation of those nodes is formatted into event Message field, ## but XML is more machine-parsable # Process UserData XML to fields, if this node exists in Event XML process_userdata = true # Process EventData XML to fields, if this node exists in Event XML process_eventdata = true ## Separator character to use for unrolled XML Data field names separator = "_" ## Get only first line of Message field. For most events first line is usually more than enough only_first_line_of_message = true ## Parse timestamp from TimeCreated.SystemTime event field. ## Will default to current time of telegraf processing on parsing error or if set to false timestamp_from_event = true ## Fields to include as tags. Globbing supported ("Level*" for both "Level" and "LevelText") event_tags = ["Source", "EventID", "Level", "LevelText", "Task", "TaskText", "Opcode", "OpcodeText", "Keywords", "Channel", "Computer"] ## Default list of fields to send. All fields are sent by default. Globbing supported event_fields = ["*"] ## Fields to exclude. Also applied to data fields. Globbing supported exclude_fields = ["TimeCreated", "Binary", "Data_Address*"] ## Skip those tags or fields if their value is empty or equals to zero. Globbing supported exclude_empty = ["*ActivityID", "UserID"]