Extension to instrument Azure Functions #1766
Conversation
We use a Worker Extension to insert a middleware of sorts into the execution flow. This allows us to access the context independent of the function definition.
| [[azure-functions-support]] | ||
| === Monitoring Azure Functions | ||
|
|
||
| Incorporating Elastic APM into your Azure Functions App is straight forward! |
There was a problem hiding this comment.
I'm leaning towards deleting this line. I'm not sure it adds anything useful.
There was a problem hiding this comment.
Yup, true, it got cargo-culted from one docs page to the next. Should probably remove all of them.
|
|
||
| Elastic APM uses https://learn.microsoft.com/en-us/azure/azure-functions/functions-reference-python?tabs=asgi%2Capplication-level&pivots=python-mode-configuration#python-worker-extensions[Worker Extensions] | ||
| to instrument Azure Functions. | ||
| This feature has to be enabled in your Azure Functions App. |
There was a problem hiding this comment.
| This feature has to be enabled in your Azure Functions App. | |
| This feature is not enabled by default, and must be enabled in your Azure Functions App. |
| ElasticAPMExtension.configure() | ||
| ---- | ||
|
|
||
| Put them somewhere at the top of your Python file, before the function definitions. |
There was a problem hiding this comment.
How critical is their placement? Do they need to be before any init code or just before the function defs?
|
|
||
| You need to add `elastic-apm` as a dependency for your Functions app. | ||
| Simply add `elastic-apm` to your `requirements.txt` file. | ||
| We recommend to pin the version to the current newest version of the agent, and periodically update it. |
There was a problem hiding this comment.
| We recommend to pin the version to the current newest version of the agent, and periodically update it. | |
| We recommend pinning the version to the current newest version of the agent, and periodically updating the version. |
| The APM Python agent is configured through https://learn.microsoft.com/en-us/azure/azure-functions/functions-how-to-use-azure-function-app-settings?tabs=portal#settings[App Settings]. | ||
| These are then picked up by the agent as environment variables. | ||
|
|
||
| For the minimal configuration, you will need the _APM Server URL_ to set the destination for APM data and an _{apm-guide-ref}/secret-token.html[APM Secret Token]_. |
There was a problem hiding this comment.
Should we link to our configuration docs for these?
| you can retrieve the `Client` object for capturing exceptions/messages | ||
| using <<api-get-client,`get_client`>>. | ||
|
|
||
| NOTE: Currently, only HTTP and timer triggers are supported. |
There was a problem hiding this comment.
I wonder if this should be at the top? I don't know how much Azure function usage falls outside of these triggers but it seems like an important note.
| client = None | ||
|
|
||
| @classmethod | ||
| def init(cls): |
There was a problem hiding this comment.
Should we be gating this to obey enabled and instrument configs? I'm assuming this is getting called in the AppExtensionBase somewhere, perhaps we should put in a docstring noting where/how this is called?
|
|
||
| @classmethod | ||
| def post_function_load_app_level(cls, function_name: str, function_directory: str, *args, **kwargs): | ||
| with codecs.open(os.path.join(function_directory, "function.json")) as f: |
There was a problem hiding this comment.
Any particular reason you're using codecs.open instead of just open? My understanding is that codecs.open is obsolete in py3.x but I could have missed something.
Co-authored-by: Colton Myers <colton@basepi.net>
What does this pull request do?
We use a Worker Extension to insert a middleware of sorts into the execution flow. This allows us to access the context independent of the function definition.
Related issues
Closes #1675
Closes #1722