Send-ServiceFabricServiceHealthReport
Отправляет отчет о работоспособности в службе Service Fabric.
Синтаксис
Send-ServiceFabricServiceHealthReport
[-ServiceName] <Uri>
-HealthState <HealthState>
-SourceId <String>
-HealthProperty <String>
[-Description <String>]
[-TimeToLiveSec <Int32>]
[-RemoveWhenExpired]
[-SequenceNumber <Int64>]
[-Immediate]
[-TimeoutSec <Int32>]
[<CommonParameters>] Описание
Командлет Send-ServiceFabricServiceHealthReport отправляет отчет о работоспособности в службе Service Fabric.
Служба уже должна существовать в хранилище работоспособности. Чтобы проверить, существует ли она, используйте командлет Get-ServiceFabricServiceHealth и укажите параметр ServiceName . Кроме того, можно использовать командлет Get-ServiceFabricApplicationHealth , чтобы получить сведения о приложении, а затем проверить раздел состояний работоспособности службы, чтобы найти нужную службу.
Отчет отправляется после количества секунд, указанного в параметре HealthReportSendIntervalInSec командлета Connect-ServiceFabricCluster . Подключение к кластеру должно оставаться в активном режиме в течение этого времени.
Командлет может возвращать успешное выполнение, но отчет отправляется асинхронно, поэтому его обработка может завершиться ошибкой. Чтобы узнать, применен ли отчет в хранилище работоспособности, используйте командлет Get-ServiceFabricServiceHealth и убедитесь, что отчет отображается в разделе HealthEvents.
Перед выполнением любой операции в кластере Service Fabric установите подключение к кластеру с помощью командлета Connect-ServiceFabricCluster .
Примеры
Пример 1. Отчет о работоспособности отчета об ошибках с бесконечным сроком жизни
PS C:\> Send-ServiceFabricServiceHealthReport -ServiceName fabric:/MyApplication/MyService -SourceId "MyWatchdog" -HealthProperty "Availability" -HealthState Error -Description "The service is not available."Эта команда отправляет отчет о работоспособности службы с именем fabric:/MyApplication/MyService из источника MyWatchDog. Отчет о работоспособности содержит сведения о доступности свойства работоспособности в состоянии работоспособности с бесконечным сроком жизни. Эта команда также содержит описание ошибки.
Пример 2. Предупреждение отчета, допустимое для указанного срока жизни
PS C:\> Send-ServiceFabricServiceHealthReport -ServiceName fabric:/MyApplication/MyService -SourceId "MyWatchdog" -HealthProperty "PrivateData" -HealthState Warning -TimeToLiveSec 10 -RemoveWhenExpired -Description "Accessing private data in database MyServicePrivateData is slow."Эта команда отправляет отчет о работоспособности службы с именем fabric:/MyApplication/MyService из источника MyWatchdog. Отчет о работоспособности содержит сведения о свойстве работоспособности PrivateData в состоянии работоспособности предупреждения с сроком жизни 10 секунд и помечает отчет об удалении по истечении срока действия.
Параметры
-Description
Указывает доступные для чтения данные о условии, активировав отчет. Параметры SourceId, HealthProperty и HealthState полностью описывают отчет.
Максимальная длина строки для описания составляет 4096 символов. Если указанная строка длиннее, она автоматически усечена. При усечении описание заканчивается маркером "[Усечено]", чтобы указать пользователям, что усечение произошло. Общий размер строки составляет 4096 символов, поэтому сохраняются менее 4096 символов из исходной строки.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-HealthProperty
Указывает свойство отчета. Вместе с параметром SourceId это свойство однозначно идентифицирует отчет.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-HealthState
Указывает объект HealthState , представляющий сообщаемое состояние работоспособности.
| Type: | HealthState |
| Accepted values: | Invalid, Ok, Warning, Error, Unknown |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Immediate
Указывает, следует ли немедленно отправлять отчет в хранилище работоспособности. Это полезно для критически важных отчетов, которые необходимо передать как можно быстрее. Если этот параметр не указан, отчет отправляется на основе параметров клиента работоспособности. Это значит, что он будет включен в пакет отчетов в соответствии со значением параметра HealthReportSendInterval. Рекомендуется применять именно такой вариант, так как он позволяет клиенту работоспособности оптимизировать отправку отчетов в хранилище данных о работоспособности, а также обработку отчетов о работоспособности. По умолчанию клиент структуры PowerShell устанавливает для HealthReportSentInterval значение 0, поэтому отчеты отправляются немедленно.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RemoveWhenExpired
Указывает, что отчет удаляется из хранилища работоспособности по истечении срока действия. Если этот параметр не указан, сущность считается в состоянии ошибки, когда истекает срок жизни отчета. Отчеты, которые удаляются при истечении срока действия, можно использовать для условий, которые действительны только в течение определенного периода времени или для очистки отчетов из хранилища работоспособности.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SequenceNumber
Указывает порядковый номер, связанный с отчетом о работоспособности. Если значение для этого параметра не указано, порядковый номер задается автоматически. Если указать порядковый номер, это значение должно быть больше, чем любой предыдущий порядковый номер, заданный для одного и того же SourceId и HealthProperty, или отчет отклоняется из-за устаревания.
| Type: | Int64 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ServiceName
Указывает универсальный код ресурса (URI) службы Service Fabric.
| Type: | Uri |
| Position: | 0 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SourceId
Указывает идентификатор источника, который активировал отчет.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-TimeoutSec
Указывает период времени ожидания (в секундах) для операции.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TimeToLiveSec
Указывает срок жизни отчета в секундах. По истечении срока жизни отчет удаляется из хранилища работоспособности, если указан параметр RemoveWhenExpired . В противном случае сущность вычисляется по ошибке из-за истечения срока действия отчета. Значение по умолчанию — Infinite.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
Входные данные
System.Uri
System.Fabric.Health.HealthState
System.String
System.Nullable`1[[System.Int32, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
System.Management.Automation.SwitchParameter
System.Nullable`1[[System.Int64, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
Выходные данные
System.Object