From 97459783f84b0590f5fee356c9b40cb1b85a415a Mon Sep 17 00:00:00 2001 From: Hans Glad Date: Sun, 9 Mar 2025 18:48:12 +0100 Subject: [PATCH] IS-18133: Document new tokens property in execution log entities and fix some typos --- hub/changelog.rst | 11 +++++++++++ hub/documentation/operations/pump-execution.rst | 7 +++++-- .../systems/configuration-systems-url.rst | 2 ++ 3 files changed, 18 insertions(+), 2 deletions(-) diff --git a/hub/changelog.rst b/hub/changelog.rst index e97138d409..392cedbb76 100644 --- a/hub/changelog.rst +++ b/hub/changelog.rst @@ -1,6 +1,17 @@ Changelog ========= +.. _changelog_2025-03-09: + +2025-03-09 +---------- +* Pump execution log entities now have a property ``tokens`` if :ref:`custom authentication ` or + :ref:`OAuth2 authentication ` is used on any of the connected systems. The property exposes the + expiry dates for the tokens used by these systems. The purpose of this is to show the resulting output of the + ``expires_in_expression`` and ``expires_at_expression`` Jinja expressions, which can potentially produce the + wrong date if they are misconfigured. + + .. _changelog_2025-02-28: 2025-02-28 diff --git a/hub/documentation/operations/pump-execution.rst b/hub/documentation/operations/pump-execution.rst index 2d9e8de63e..fcacc9aa06 100644 --- a/hub/documentation/operations/pump-execution.rst +++ b/hub/documentation/operations/pump-execution.rst @@ -17,6 +17,9 @@ runs. The first will have the id "pump-started" and the last either "pump-ended" *or* "pump-completed". In between these entities, there may be entities recording read errors and/or write errors. Other informational entities such as "pump-enabled"/"pump-disabled" or "pipe-offset-set" may also be present. +The entities will also contain a ``tokens`` property if :ref:`custom authentication ` or +:ref:`OAuth2 authentication ` is used on any systems that the pipe uses. This property exposes +expiry dates for any tokens that the systems are using. Depending on the pump settings, the write errors can then be retried one or more times during the next runs. @@ -263,7 +266,7 @@ Properties The read-error entity --------------------- -The execution dataset also can contain entities that record failed reads and/or entities wich represents retryable +The execution dataset can also contain entities that record failed reads and/or entities which represents retryable entities (from write errors). Prototype @@ -391,7 +394,7 @@ Properties - Boolean - A flag indicating if the entity can be retried by the retry mechanism. It is used for the case where a new version of a entity comes from the source while there also exist a previously failed version in the - execution dataset. In this case, if the new version is sucessfully written to the sink a new write-error entity + execution dataset. In this case, if the new version is successfully written to the sink a new write-error entity is written to the log for this entity, but marked as not retryable (i.e ``false`` value) so it can be skipped during retries. diff --git a/hub/documentation/service-configuration/systems/configuration-systems-url.rst b/hub/documentation/service-configuration/systems/configuration-systems-url.rst index f5675f90e5..4906947d87 100644 --- a/hub/documentation/service-configuration/systems/configuration-systems-url.rst +++ b/hub/documentation/service-configuration/systems/configuration-systems-url.rst @@ -134,6 +134,8 @@ Properties - - + .. _url_system_oauth2: + * - ``oauth2`` - Dict - A optional set of properties that specifies support for automatic fetching of JWT access tokens from a oauth2