Send-ServiceFabricDeployedServicePackageHealthReport
Отправляет отчет о работоспособности в развернутом пакете службы Service Fabric.
Синтаксис
Send-ServiceFabricDeployedServicePackageHealthReport
[-ApplicationName] <Uri>
[-ServiceManifestName] <String>
[-NodeName] <String>
[[-ServicePackageActivationId] <String>]
-HealthState <HealthState>
-SourceId <String>
-HealthProperty <String>
[-Description <String>]
[-TimeToLiveSec <Int32>]
[-RemoveWhenExpired]
[-SequenceNumber <Int64>]
[-Immediate]
[-TimeoutSec <Int32>]
[<CommonParameters>]
Описание
Командлет Send-ServiceFabricDeployedServicePackageHealthReport отправляет отчет о работоспособности в развернутом пакете службы Service Fabric.
Развернутый пакет службы должен уже существовать в хранилище работоспособности.
Чтобы проверить наличие службы, используйте командлет Get-ServiceFabricDeployedServicePackageHealth.
Укажите имя приложения, имя пакета службы и имя узла.
Кроме того, можно использовать командлет Get-ServiceFabricDeployedApplicationHealth
Командлет отправляет отчет после интервала, указанного параметром HealthReportSendIntervalInSec командлета Connect-ServiceFabricCluster. Подключение к кластеру должно оставаться в живых в течение этого времени. Команда вычисляется на клиенте без ссылки на выполнение в хранилище работоспособности. Отчет может не применяться в хранилище работоспособности, даже если команда возвращает успешное выполнение. Например, хранилище работоспособности может отклонить отчет из-за недопустимого параметра, например устаревший порядковый номер.
Чтобы узнать, был ли отчет применен в хранилище работоспособности, используйте командлет Get-ServiceFabricDeployedServicePackageHealth и убедитесь, что отчет отображается в разделе HealthEvents.
Чтобы управлять кластерами Service Fabric, запустите Windows PowerShell с помощью параметра "Запуск от имени администратора". Перед выполнением любой операции в кластере Service Fabric установите подключение к кластеру с помощью командлета Connect-ServiceFabricCluster, а затем командлет Get-ServiceFabricClusterConnection.
Примеры
Пример 1. Отчет о работоспособности отчета об ошибке с бесконечным сроком жизни
PS C:\> Send-ServiceFabricDeployedServicePackageHealthReport -ApplicationName fabric:/MyApplication -NodeName "Node01" -ServiceManifestName "MyServiceManifest" -HealthProperty "Memory" -HealthState Error -SourceId "MyWatchdog"
Эта команда отправляет отчет о работоспособности развернутого пакета службы для приложения с именем fabric:/MyApplication на узле с именем Node01 для манифеста службы с именем MyServiceManifest. Отчет о работоспособности содержит сведения о свойстве работоспособности памяти в состоянии работоспособности ошибки из источника MyWatchdog с бесконечным TTL. Описание не задано, а порядковый номер устанавливается автоматически.
Пример 2. Предупреждение отчета, допустимое для указанного срока жизни, и удалите его при истечении срока действия
PS C:\> Send-ServiceFabricDeployedServicePackageHealthReport -ApplicationName fabric:/MyApplication -ServiceManifestName MyServiceManifest -NodeName "Node01" -HealthProperty "CustomSetup" -HealthState Warning -SourceId MyWatchdog -RemoveWhenExpired -Description "The setup has completed with some warnings." -TimeToLiveSec 10
Эта команда отправляет отчет о работоспособности развернутого пакета службы для приложения с именем fabric:/MyApplication для манифеста службы с именем MyServiceManifest на узле с именем Node01. Отчет о работоспособности содержит сведения о свойстве работоспособности CustomSetup в состоянии работоспособности предупреждений из источника MyWatchdog с 10 секундами TTL. После истечения срока действия отчета он удаляется из хранилища работоспособности и больше не будет влиять на оценку работоспособности. Эта команда также содержит описание предупреждения.
Параметры
-ApplicationName
Указывает универсальный идентификатор ресурса (URI) приложения Service Fabric. Командлет отправляет отчет о работоспособности приложения с заданным универсальным кодом ресурса (URI).
Тип: | Uri |
Position: | 0 |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-Description
Указывает удобочитаемую пользователем информацию о условии, которое активировало отчет. SourceId, HealthPropertyи параметры HealthState полностью описывают отчет.
Максимальная длина строки описания — 4096 символов. Если указанная строка длиннее, она автоматически усечена. При усечении описание заканчивается маркером "[Усечено], чтобы указать пользователям, что усечение произошло. Общий размер строки составляет 4096 символов, поэтому хранятся менее 4096 символов из исходной строки.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-HealthProperty
Указывает свойство отчета. Вместе с параметром SourceId SourceId это свойство однозначно идентифицирует отчет. Отчет переопределяет все предыдущие отчеты с теми же значениями для SourceId и параметры HealthProperty в одной сущности.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-HealthState
Указывает объект HealthState, представляющий сообщаемое состояние работоспособности.
Тип: | HealthState |
Допустимые значения: | Invalid, Ok, Warning, Error, Unknown |
Position: | Named |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-Immediate
Указывает, следует ли немедленно отправлять отчет в хранилище работоспособности. Это полезно для критических отчетов, которые должны отправляться как можно скорее. Если это не указано, отчет отправляется на основе параметров клиента работоспособности. Таким образом, он будет пакетирован в соответствии с конфигурацией HealthReportSendInterval. Это рекомендуемый параметр, так как он позволяет клиенту работоспособности оптимизировать сообщения отчетов о работоспособности в хранилище работоспособности, а также обработку отчетов о работоспособности. По умолчанию клиент Структуры PowerShell задает значение HealthReportSentInterval равным 0, поэтому отчеты отправляются немедленно.
Тип: | SwitchParameter |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-NodeName
Указывает имя узла Service Fabric. Командлет отправляет отчет о работоспособности пакета службы, развернутого на заданном узле.
Тип: | String |
Position: | 2 |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-RemoveWhenExpired
Указывает, что отчет удаляется из хранилища работоспособности при истечении срока его действия. Если этот параметр не указан, сущность считается в состоянии ошибки при истечении срока действия отчета. Отчеты, которые удаляются при истечении срока действия, можно использовать только для условий, допустимых только в течение определенного периода времени или для очистки отчетов из хранилища работоспособности.
Тип: | SwitchParameter |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-SequenceNumber
Указывает порядковый номер, связанный с отчетом о работоспособности. Если значение этого параметра не указано, порядковый номер устанавливается автоматически. Если указать порядковый номер, это значение должно быть выше, чем любой предыдущий номер последовательности, заданный в том же SourceId и HealthProperty, или отчет отклоняется из-за устаревания.
Тип: | Int64 |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-ServiceManifestName
Указывает имя манифеста службы Service Fabric. Вместе с ApplicationName и NodeNameэто значение однозначно определяет сущность работоспособности развернутого пакета службы.
Тип: | String |
Position: | 1 |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-ServicePackageActivationId
Идентификатор активации развернутой ServicePackage. Это можно получить с помощью запроса Get-ServiceFabricDeployedServicePackage.
Если ServicePackageActivationMode, указанной во время создания службы (с помощью New-ServiceFabricService
), SharedProcess (или если он не указан, в этом случае значение по умолчанию SharedProcess), значение ServicePackageActivationId всегда является пустой строкой и не нужно указывать. Дополнительные сведения об идентификаторе активации пакета службы см. в статье [Модель размещения Service Fabric][1].
Тип: | String |
Position: | 3 |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-SourceId
Указывает идентификатор источника, активировающего отчет.
Тип: | String |
Position: | Named |
Default value: | None |
Обязательно: | True |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
-TimeoutSec
Указывает период времени ожидания (в секундах) для операции.
Тип: | Int32 |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | False |
Принять подстановочные знаки: | False |
-TimeToLiveSec
Указывает время жизни отчета в секундах. По истечении срока действия TTL отчет удаляется из хранилища работоспособности, если указан параметр RemoveWhenExpired. В противном случае сущность оценивается по ошибке из-за истечения срока действия отчета. Значение по умолчанию — Infinite.
Тип: | Int32 |
Position: | Named |
Default value: | None |
Обязательно: | False |
Принять входные данные конвейера: | True |
Принять подстановочные знаки: | False |
Входные данные
System.Uri
System.String
System.Fabric.Health.HealthState
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