本文介绍在函数计算中使用Python运行时开发代码时,所涉及的Context(上下文)的相关概念和使用示例。

什么是上下文

函数计算运行您的函数时,会将上下文对象传递到执行方法中。该对象包含有关调用、服务、函数、链路追踪和执行环境等信息。

事件请求处理程序(Event Handler)和HTTP请求处理程序(HTTP Handler)都支持上下文对象作为传入参数,且格式和内容相同。上下文对象主要提供了以下参数。
字段 类型 说明
request_id String

本次调用请求的唯一ID。您可以记录该ID,当函数调用出现问题时方便查询。

credentials Credentials结构,包含以下字段:
  • access_key_id
  • access_key_secret
  • security_token

函数计算服务通过扮演服务角色而获取的一组临时密钥,其有效时间是36小时。您可以在代码中使用Credentials去访问相应的服务例如OSS,这就避免了您把自己的AccessKey信息编码在函数代码里。详细信息,请参见通过RAM角色实现跨云账号授权

function FunctionMeta结构,包含以下字段:
  • name
  • handler
  • memory
  • timeout

当前调用的函数的一些基本信息,例如函数名、函数入口、函数内存和超时时间。

service ServiceMeta结构,包含以下字段:
  • name
  • log_project
  • log_store
  • qualifier
  • version_id

当前调用的函数所在的服务信息,包含服务名称、接入的日志服务SLS的Project和Logstore信息,以及服务的版本和别名信息。其中qualifier表示调用函数时指定的服务版本或别名,version_id表示实际调用的服务版本。

region String

当前调用的函数所在地域ID,例如在华东2(上海)地域调用,则地域ID为cn-shanghai。详细信息,请参见服务接入地址

account_id String

函数所属的阿里云账号ID(主账号ID)。

tracing Tracing结构,包含以下字段:
  • span_context
  • jaeger_endpoint
  • span_baggages
  • parseOpenTracingBaggages

链路追踪相关参数。具体信息,请参考链路追踪简介

关于上下文的具体信息,请参见如下格式。

# -*- coding: utf-8 -*-

import json


class Credentials:
    def __init__(self, access_key_id, access_key_secret, security_token):
        self.access_key_id = access_key_id
        self.access_key_secret = access_key_secret
        self.security_token = security_token


class ServiceMeta:
    def __init__(self, service_name, log_project, log_store, qualifier, version_id):
        self.name = service_name
        self.log_project = log_project
        self.log_store = log_store
        self.qualifier = qualifier
        self.version_id = version_id


class Tracing:
    def __init__(self, span_context, base64_baggages, jaeger_endpoint):
        self.span_context = span_context
        self.jaeger_endpoint = jaeger_endpoint
        self.span_baggages = self.parseOpenTracingBaggages(base64_baggages)

    def parseOpenTracingBaggages(self, base64_baggages):
        span_baggages = {}
        # None || '' returns false
        if base64_baggages:
            try:
                import base64
                str_baggages = base64.b64decode(base64_baggages)
                span_baggages = json.loads(str_baggages)
            except Exception as e:
                import logging
                fc_sys_logger = logging.getLogger('fc_sys_logger')
                fc_sys_logger.error('Failed to parse base64 opentracing baggages:[{}], err: {}'.format(base64_baggages, e))
        return span_baggages


class FunctionMeta:
    def __init__(self, name, handler, memory, timeout):
        self.name = name
        self.handler = handler
        self.memory = memory
        self.timeout = timeout


class FCContext:
    def __init__(self, account_id, request_id, credentials, function_meta, service_meta, region, tracing):
        self.credentials = credentials
        self.function = function_meta
        self.request_id = request_id
        self.service = service_meta
        self.region = region
        self.account_id = account_id
        self.tracing = tracing

使用示例

关于上下文的使用示例,请参见示例二:通过临时密钥安全读写OSS的资源