PowerShell V2 CTP3 вышел уже давно (23 декабря прошлого года), но всё никак не доходили руки осветить новые командлеты. Сегодня постараюсь рассказать о новых возможностях работы с журналами событий готовыми командлетами. Функционал этих командлетов я уже реализовывал немного раньше:
- Управление EventLog в PowerShell с использованием .NET
- Управление EventLog в PowerShell с использованием WMI
Но плюс новых командлетов в том, что это уже готовые командлеты, а не костыли в виде отдельных функций. Безусловно, ещё не всё работает как положено, но обзор уже делать можно. Итак, список командлетов:
- Get-WinEvent
- New-EventLog
- Write-EventLog
- Clear-Eventlog
- Limit-EventLog
- Remove-EventLog
начнём попорядку:
1) Get-WinEvent. Данный командлет призван заменить ранее использовавшийся командлет Get-Eventlog. Синтаксис команды может быть следующий:
[System32] Get-WinEvent -ListLog * | ft -a
LogName MaximumSizeInBytes RecordCount LogMode
------- ------------------ ----------- -------
Application 20971520 17003 Circular
DFS Replication 15532032 6 Circular
HardwareEvents 20971520 0 Circular
Internet Explorer 1052672 0 Circular
Key Management Service 20971520 0 Circular
ODiag 16777216 267 Circular
OSession 16777216 544 Circular
Security 33554432 16904 Circular
System 20971520 43146 Circular
Windows PowerShell 15728640 16803 Circular
ForwardedEvents 20971520 Circular
Microsoft-Windows-Backup 1052672 6 Circular
Microsoft-Windows-Bits-Client/Analytic 1052672 Circular
Microsoft-Windows-Bits-Client/Operational 1052672 2226 Circular
....Показ всех журналов событий в системе, включая журналы в Application and Services Logs (для Vista/2008). Вместо звёздочки можно указать конкретный журнал событий.
Примечание: некоторые журналы, как Security будут генерировать ошибку, если вы исполняете эту команду под обычным пользователем.
Последняя колонка показывает режим очистки журнала. Circular означает перезапись более старых событий по мере необходимости. Так же можно посмотреть список провайдеров, которые регистрируют события в журнале:
[System32] Get-WinEvent -ListProvider *
Name LogLinks
---- --------
.NET Runtime {Application}
.NET Runtime Optimization Service {Application}
Active Server Pages {Application}
Application {Application}
Application Error {Application}
Application Hang {Application}
Application Management {Application}
ASP.NET 1.1.4322.0 {Application}
ASP.NET 2.0.50727.0 {Application}
CardSpace 3.0.0.0 {Application}
Chkdsk {Application}
Crystal Reports {Application}
DataDynamics ActiveBar 1.0 {Application}
Desktop Window Manager {Application}
devenv {Application}
....Вот образец провайдеров. Это может быть очень удобным, когда вам нужна выборка именно логов конкретного провайдера. Делается это следующей командой:
Get-WinEvent -ProviderName "Application Hang"
В кавычках просто указываете поставщика событий. Сами события можно посмотреть следующим образом:
[System32] Get-WinEvent -ProviderName "Application Hang" -MaxEvents 1 | select *
Message :
Id : 1002
Version :
Qualifiers : 0
Level : 2
Task : 101
Opcode :
Keywords : 36028797018963968
RecordId : 16431
ProviderName : Application Hang
ProviderId :
LogName : Application
ProcessId :
ThreadId :
MachineName : Thor
UserId :
TimeCreated : 2008.12.21. 17:19:47
ActivityId :
RelatedActivityId :
ContainerLog : application
MatchedQueryIds : {}
Bookmark : System.Diagnostics.Eventing.Reader.EventBookmark
LevelDisplayName :
OpcodeDisplayName :
TaskDisplayName :
KeywordsDisplayNames : {}
Properties : {System.Diagnostics.Eventing.Reader.EventProperty, System.Diagnostics.Eventing.Reader.EventPrope
rty, System.Diagnostics.Eventing.Reader.EventProperty, System.Diagnostics.Eventing.Reader.EventP
roperty...}
[System32]вот так выглядят внутренности события. Однако, свойство Message ничего не содержит, хотя предполагается, что там должен быть текст самого эвента. Пустое оно потому что:
[System32] Get-WinEvent -ProviderName "Application Hang" -MaxEvents 1 | gm -MemberType noteproperty
TypeName: System.Diagnostics.Eventing.Reader.EventLogRecord
Name MemberType Definition
---- ---------- ----------
Message NoteProperty Message=null
[System32]в членах объекта мы видим, что свойство Message заткнуто заглушкой (Message=null) и оно ничего не возвращает. Но текст события можно извлечь из свойства Properties:
[System32] (Get-WinEvent -ProviderName "Application Hang" -MaxEvents 1).properties
Value
-----
mstsc.exe
6.0.6002.18000
ac0
01c9637bc8453f5e
8
{67, 0, 114, 0...}
[System32]текст тут невнятный совсем. Для некоторых событий он возвращает такой же текст, что и в графическом журнале событий (и которые корректно отображаются командлетом Get-EventLog). Те события, которые не показывает корректно Get-EventLog в новом командлете уже не показывают ничего. Тут вся надежда на разработчиков, что они наконец-то сделают возможность полностью видеть тексты всех эвентов журнала событий, в противном случае придётся снова забивать костыли с помощью адского WMI. Но тут следует обратить внимание на параметр MaxEvents. Без его указания поиск только нескольких событий (например, первых 10 с использованием Select -First 10) займёт значительное время, поскольку команда будет работать пока весь журнал не будет прочёсан. Этот параметр является аналогом параметра -Newest для Get-EventLog. Поэтому если вы хотите посмотреть только часть событий, то используйте этот параметр. В общем смысле это выглядит так:
- старая нотация: Get-EventLog application -Source "Application Hang" -Newest 5
- новая нотация: Get-WineVent -ProviderName "Application Hang" -MaxEvents 5
И ещё одно хорошее отличие нового командлета - теперь не обязательно указывать журнал для поиска. Вы можете указать только поставщика событий и количество событий для вывода. Это очень удобно.
Следовательно можно судить, что новый командлет Get-WinEvent является значимо более лучшим, чем прежний Get-EventLog. Хотя его применимость в настоящее время весьма сомнительна, поскольку работу с текстом событий так никто и не сделал.
2) New-EventLog. Нетрудно догадаться, что этот командлет создаёт новый журнал событий:
New-EventLog -LogName "Custom EventLog" -Source "Custom Source"
[System32] New-EventLog -LogName "Custom EventLog" -Source "Custom Source"
[System32] Get-EventLog -List
Max(K) Retain OverflowAction Entries Name
------ ------ -------------- ------- ----
20 480 0 OverwriteAsNeeded 17 011 Application
512 7 OverwriteOlder 0 Custom EventLog
15 168 0 OverwriteAsNeeded 6 DFS Replication
20 480 0 OverwriteAsNeeded 0 HardwareEvents
512 7 OverwriteOlder 0 Internet Explorer
20 480 0 OverwriteAsNeeded 0 Key Management Service
16 384 0 OverwriteAsNeeded 267 ODiag
16 384 0 OverwriteAsNeeded 544 OSession
32 768 0 OverwriteAsNeeded 16 908 Security
20 480 0 OverwriteAsNeeded 43 162 System
15 360 0 OverwriteAsNeeded 16 920 Windows PowerShell
[System32] Get-WinEvent -ListProvider "custom Source"
Name LogLinks
---- --------
Custom Source {Custom EventLog}
[System32]Всё очень просто. Внизу я сделал проверку, что наш провайдер событий успешно зарегистрировался и он будет писать только в журнал Custom EventLog. Так же можно и добавлять события (поставщиков) к существующим журналам. Для этого в параметре -LogName нужно указать существующий журнал.
3) Write-Eventlog. Так же по смыслу можно догадаться, что данный командлет добавляет записи в журнал событий. Общий синтаксис его такой:
Write-EventLog -LogName "Custom EventLog" -Source "Custom Source" -EntryType Information -EventID 1 -Message "Привет мир!"
EntryType может иметь следующие значения: Error, Warning, Information, SuccessAudit, FailureAudit. Об этом я уже говорил ранее здесь. Смотрим:
[[System32] Write-EventLog -LogName "Custom EventLog" -Source "Custom Source" -EntryType Information -EventID 1 -Message
"Привет мир!"
[System32] Get-WinEvent -ProviderName "Custom source"
TimeCreated ProviderName Id Message
----------- ------------ -- -------
2009.01.02. 21:05:06 Custom Source 1
[System32] Get-WinEvent -ProviderName "Custom source" | select *
Message :
Id : 1
Version :
Qualifiers : 0
Level : 4
Task : 1
Opcode :
Keywords : 36028797018963968
RecordId : 1
ProviderName : Custom Source
ProviderId :
LogName : Custom EventLog
ProcessId :
ThreadId :
MachineName : Thor
UserId :
TimeCreated : 2009.01.02. 21:05:06
ActivityId :
RelatedActivityId :
ContainerLog : custom eventlog
MatchedQueryIds : {}
Bookmark : System.Diagnostics.Eventing.Reader.EventBookmark
LevelDisplayName :
OpcodeDisplayName :
TaskDisplayName :
KeywordsDisplayNames : {}
Properties : {System.Diagnostics.Eventing.Reader.EventProperty}
[System32] (Get-WinEvent -ProviderName "custom source").Properties
Value
-----
Привет мир!
[System32]Первой строкой мы создали новое событие в журнале, второй посмотрели общую сводку по провайдеру Custom Source, которого мы создали ранее. В нём уже зарегистрировано одно событие, которое мы посмотрели в расширенном виде. И последней строкой посмотрели текст созданного события.
Спросите вы, какая польза от этого, ведь кроме программистов это мало кому нужно? А польза есть от него. Для примера можно взять резервное копирование. Например, у администратор регулярно выполняются скрипты, которые делают резервное копирование данных. И создав нового провайдера или новый журнал администратор может в скрипт добавить код, который будет лог копирования помещать в журнал событий помимо стандартной процедуры отправки лога к себе на почту. Это может оказаться очень удобным! Так же данный командлет содержит параметр -WhatIf, который следует использовать в отладочных целях.
4) Clear-EventLog. Очистка журнала:
Clear-EventLog -LogName "Custom EventLog"
тут всё проще постого. Указываете имя журнала и очищаем его:
[System32] Clear-EventLog "Custom EventLog"
[System32] Get-EventLog -List
Max(K) Retain OverflowAction Entries Name
------ ------ -------------- ------- ----
20 480 0 OverwriteAsNeeded 17 011 Application
512 7 OverwriteOlder 0 Custom EventLog
15 168 0 OverwriteAsNeeded 6 DFS Replication
20 480 0 OverwriteAsNeeded 0 HardwareEvents
512 7 OverwriteOlder 0 Internet Explorer
20 480 0 OverwriteAsNeeded 0 Key Management Service
16 384 0 OverwriteAsNeeded 267 ODiag
16 384 0 OverwriteAsNeeded 544 OSession
32 768 0 OverwriteAsNeeded 16 908 Security
20 480 0 OverwriteAsNeeded 43 165 System
15 360 0 OverwriteAsNeeded 16 920 Windows PowerShell
[System32]Во второй строчке мы уже видим, что нами созданный журнал очистился от тестового сообщения. Данный командлет содержит параметр -WhatIf, который следует использовать в отладочных целях.
5) Limit-EventLog. Позволяет изменять размер журнала и политику перезаписи журнала. Общий синтаксис такой:
Limit-EventLog -LogName "Custom EventLog" -MaximumSize 64mb -OverflowAction OverWriteOlder -RetentionDays 10
[System32] Limit-EventLog -LogName "Custom EventLog" -MaximumSize 64mb -OverflowAction OverWriteOlder -RetentionDays 10
[System32] Get-EventLog -List
Max(K) Retain OverflowAction Entries Name
------ ------ -------------- ------- ----
20 480 0 OverwriteAsNeeded 17 011 Application
65 536 10 OverwriteOlder 0 Custom EventLog
15 168 0 OverwriteAsNeeded 6 DFS Replication
20 480 0 OverwriteAsNeeded 0 HardwareEvents
512 7 OverwriteOlder 0 Internet Explorer
20 480 0 OverwriteAsNeeded 0 Key Management Service
16 384 0 OverwriteAsNeeded 267 ODiag
16 384 0 OverwriteAsNeeded 544 OSession
32 768 0 OverwriteAsNeeded 16 908 Security
20 480 0 OverwriteAsNeeded 43 165 System
15 360 0 OverwriteAsNeeded 16 920 Windows PowerShell
[System32]Здесь мы задали размер журнала в 64 мегабайта и политику перезаписи старых логов старше 10 дней.
6) Remove-EventLog. Удаляет журнал событий или провайдера событий:
Remove-EventLog -Source "Custom Source" - удаляет провайдера событий из системы
Remove-EventLog -LogName "Custom EventLog" - удаляет указанный журнал из системы
И этот командлет содержит параметр -WhatIf.
В принципе, есть ещё командлет Remove-Event, который должен позволять удалять события из журналов событий, но мне пока что не удалось заставить его работать. Но вообще удаление эвентов из журналов событий - плохая и порочная практика, которая ни к чему хорошему не приведёт.
Вот мы и рассмотрели все новые командлеты в PowerShell V2 CTP3, которые относятся к работе с журналами событий (эвентлогами). В самом начале поста я привёл ссылки, на альтернативные решения, которые повторяют функционал этих командлетов для версии 1.0, но и даже умеют немножко больше (например, архивация и ротация архивов эвентлогов). В целом можно оценить позитив от новых командлетов, которые позволяют нам более удобным способом работать с журналами событий. Но всё равно нужно ждать рабочего решения, который смог бы получать тексты сообщений из журналов Windows Vista/Windows Server 2008, поскольку без него все эти нововведения мало кому будут нужны. Вобщем, как-то так.
Маленькая поправка, чтоб не вносить еще больше путаницы где её и так полно :) Ты описал средства для работы с журналом событий Windows, а Eventing'ом называют те командлеты и функционал что предназначены для работы с событиями WMI/.NET. То есть позволяют вызвать код в момент когда произошло какое то событие, не выполняя постоянных проверок. Например сразу при создании файла.
Ага. Пока писал даже не задумывался. Я просто переименую пост.
Comments: