inspect.json

{
    "id": "inspect",
    "summary": "Add information to the logs",
    "description": "This process can be used to add runtime information to the logs, e.g. for debugging purposes. This process should be used with caution and it is recommended to remove the process in production workflows. For example, logging each value or array individually in a process such as ``apply()`` or ``reduce_dimension()`` could lead to a (too) large number of log entries. Several data structures (e.g. data cubes) are too large to log and will only return summaries of their contents.\n\nThe data provided in the parameter `data` is returned without changes.",
    "categories": [
        "development"
    ],
    "experimental": true,
    "parameters": [
        {
            "name": "data",
            "description": "Data to log.",
            "schema": {
                "description": "Any data type is allowed."
            }
        },
        {
            "name": "message",
            "description": "A message to send in addition to the data.",
            "schema": {
                "type": "string"
            },
            "default": "",
            "optional": true
        },
        {
            "name": "code",
            "description": "A label to help identify one or more log entries originating from this process in the list of all log entries. It can help to group or filter log entries and is usually not unique.",
            "schema": {
                "type": "string"
            },
            "default": "User",
            "optional": true
        },
        {
            "name": "level",
            "description": "The severity level of this message, defaults to `info`.",
            "schema": {
                "type": "string",
                "enum": [
                    "error",
                    "warning",
                    "info",
                    "debug"
                ]
            },
            "default": "info",
            "optional": true
        }
    ],
    "returns": {
        "description": "The data as passed to the `data` parameter without any modification.",
        "schema": {
            "description": "Any data type is allowed."
        }
    }
}