MetaHandler

Meta Handler is an optional collector of all the events that were happening to the task while being orchestrated by sosw. In case you create a DynamoDB table sosw_tasks_meta in your environment, sosw will start collecting the meta data automatically. The required schema for the table is described in sosw/examples/yaml/initial/sosw-dev-shared-dynamodb.yaml .

The setup script will create the table by default.

MetaHandler can also be automatically initialised by classes, inheriting from Worker. They will then write 'completed' and 'failed' events to the DynamoDB tasks meta data table. In order to enable this feature, you have to provide 'meta_handler_config' in your custom_config. You will also need to grant write permissions for this table to your Lambda.

Config example:

{
    'meta_handler_config': {
        'write_meta_to_ddb': True,
        'dynamo_db_config': {
            'table_name':      'sosw_tasks_meta'
        }
    }
}

View Licence Agreement

sosw - Serverless Orchestrator of Serverless Workers

The MIT License (MIT)
Copyright (C) 2024  sosw core contributors <info@sosw.app>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

class sosw.managers.meta_handler.MetaHandler(custom_config: Dict | None = None, **kwargs)

MetaHandler is helper class for Essential classes. It works with DynamoDB table to store the meta data of operations on Tasks.

post(task_id: str, action: str, **kwargs)

Write row with meta data to sosw_tasks_meta DynamoDB Table if configured. As long as collecting the meta data is optional, the MetaHandler will either save it to DynamoDB or just log.

MetaHandler does not restrict the fields and actions you can post from your Worker Lambdas with the exception of the following built-in fields. These ones are always taken from the current lambda_context automatically.

• 'author'

• 'invocation_id'

• 'log_stream_name'