sentry-logger-deploy

Bulk-creates loggers defined in a logger provisioning profile on a remote sentry.

Command properties

PropertyDescription
Command typeTransforming
Required permissionAdministrator
License usageN/A
Parallel executionNot supported
Distributed executionNot supported

Syntax

sentry-logger-deploy

Input fields

FieldTypeRequiredDescription
guidstringRequiredSentry unique identifier.
profile_guidstringRequiredLogger provisioning profile identifier (GUID).

Output fields

FieldTypeDescription
_errorstringError message added to the original record if an error occurs.

Possible values for the _error field:

Error messageDescription
guid is nullThe guid field value in the input record is null.
guid should be stringThe guid field value in the input record is not a string.
guid should be non empty stringThe guid field value in the input record is an empty string.
profile_guid should be not nullThe profile_guid field value in the input record is null.
profile_guid should be stringThe profile_guid field value in the input record is not a string.
profile_guid should be non empty stringThe profile_guid field value in the input record is an empty string.
not connectedThe specified sentry is not connected.
profile not found: PROFILE_GUIDThe specified provisioning profile does not exist.

Error codes

Parsing errors
Error codeMessageDescription
23100No permission to call sentry RPC.The user does not have administrator privileges.
Runtime errors

N/A

Description

The sentry-logger-deploy command identifies a sentry by the guid field of the input record and a logger provisioning profile by the profile_guid field, then bulk-creates the loggers defined in that profile on the sentry.

This command only submits the provisioning start request and does not wait for completion. Therefore, logger creation may still be pending or in progress when the command finishes. If an error occurs during provisioning, it is recorded in the system log but no separate notification is sent.

If the input field values are invalid or the sentry is not connected, the _error field is added to the original record.

Examples

  1. Deploy a logger provisioning profile to Windows sentries

    system sentries
    | search os == "Windows*"
    | eval profile_guid = "448c0422-7a30-42ef-b73a-e855e538f779"
    | sentry-logger-deploy
    

    Bulk-creates the loggers defined in the specified provisioning profile on all sentries running Windows.