UserLogMessage ============== Write a diagnostic message to the ApertureDB server log. Requires all four ``objects`` and all four ``access_control`` CRUD permissions. No input or output blobs are used. Parameters ---------- .. list-table:: :header-rows: 1 :widths: 22 22 56 * - Parameter - Type / required - Default and behavior * - ``text`` - string / required - No default. The first 2048 bytes are logged; nonprintable characters are replaced with periods. * - ``type`` - string / optional - Defaults to INFO. Allowed values are INFO, WARNING, and ERROR, with this capitalization. Details ------- Log entries are prefixed with ``UserLogMessage:`` and use the requested severity. Dashboard visibility depends on the deployment's logging integration. Use messages to identify process starts, completions, retries, and failures; do not include passwords or personal tokens. A message may be logged even if the query fails. Log entries are not rolled back, so a message does not prove that the query's database changes succeeded. Response and recovery --------------------- Success returns ``status: 0``. The response does not echo the message. An ERROR-level message is still a successful command when accepted. .. list-table:: :header-rows: 1 :widths: 48 52 * - Failure or empty result - Cause and recovery * - Invalid type or missing text - Use a string text value and an allowed uppercase severity. * - Permission error - Run through an account with the required object and ACL permissions. See :doc:`../Responses` for validation, authentication, and permission error envelopes. Command errors use a negative ``status`` and an ``info`` message. Examples -------- .. TESTED_EXAMPLE: UserLogMessage_1 .. code-block:: json [{ "UserLogMessage": { "text": "Beginning ingestion process for dataset 'my_dataset'", "type": "INFO" } }] .. TESTED_EXAMPLE: UserLogMessage_2 .. code-block:: json [{ "UserLogMessage": { "text": "Foo command failed. Retrying...", "type": "WARNING" } }] .. TESTED_EXAMPLE: UserLogMessage_3 .. code-block:: json [{ "UserLogMessage": { "text": "Too many retries. Aborting ingestion process for dataset 'my_dataset'", "type": "ERROR" } }] Successful response: .. TESTED_EXAMPLE: UserLogMessage_response .. code-block:: json [{ "UserLogMessage": { "status": 0 } }]