Running custom availability tests using Azure Functions

February 14, 2021 by Anuraj

Azure WebJobs Monitoring Serverless

This article shows you how create and run custom availability tests using Azure Functions. This is an update to the blog post about monitoring WebJobs using Application Insights, since Microsoft is deprecating the Load Test and Performance features, this is the recommended alternative for monitoring availability. To get started you need to create an Azure function in C# with Timer Trigger. You can choose the trigger interval based on your requirement. This is one of the main advantage compared to Application Insights availability test feature. Next you need to add following packages.

  • Microsoft.ApplicationInsights - This package is for interacting with the Application Insights.
  • Microsoft.Azure.Functions.Extensions - This package is for creating a Startup class for the Azure Function.
  • Microsoft.Extensions.Http - This package is for creating the HttpClient which helps to interact with Web Jobs REST API.

This Startup class is required so that you can inject the HttpClient to the Azure Function - it is the recommended instead of creating the HttpClient instance every time in the Function code. Here is the Startup class code.

[assembly: FunctionsStartup(typeof(DotNetThoughts.Demo.Startup))]
namespace DotNetThoughts.Demo
    public class Startup : FunctionsStartup
        public override void Configure(IFunctionsHostBuilder builder)

And here is the Function implementation.

private readonly TelemetryClient _telemetryClient;
private readonly string instrumentationKey = Environment.GetEnvironmentVariable("APPINSIGHTS_INSTRUMENTATIONKEY");
private readonly string webJobAuthenticationToken = Environment.GetEnvironmentVariable("WEBJOB_AUTHORIZATION");
private readonly string webJobRESTEndpoint = Environment.GetEnvironmentVariable("WEBJOB_RESTENDPOINT");
private const string EndpointAddress = "";
private readonly IHttpClientFactory _httpClientFactory;
public WebJobAvailability(IHttpClientFactory httpClientFactory)
    _httpClientFactory = httpClientFactory;
    _telemetryClient = new TelemetryClient(
            new TelemetryConfiguration(instrumentationKey, 
            new InMemoryChannel { EndpointAddress = EndpointAddress }));

public async Task Run([TimerTrigger("0 */1 * * * *")] TimerInfo myTimer, ILogger log)
    string testName = "WebJobStatusTest";
    string location = Environment.GetEnvironmentVariable("REGION_NAME");
    string operationId = Guid.NewGuid().ToString("N");
    var availabilityTelemetry = new AvailabilityTelemetry
        Id = operationId,
        Name = testName,
        RunLocation = location,
        Success = false

        await ExecuteTestAsync(log);
        availabilityTelemetry.Success = true;
    catch (Exception ex)
        availabilityTelemetry.Message = ex.Message;

        var exceptionTelemetry = new ExceptionTelemetry(ex);
        exceptionTelemetry.Context.Operation.Id = operationId;
        exceptionTelemetry.Properties.Add("TestName", testName);
        exceptionTelemetry.Properties.Add("TestLocation", location);

The ExecuteTestAsync execute the business logic or test implementation. In this you will be writing the code to interact with Kudu REST endpoint and verify the response status code.

public async Task ExecuteTestAsync(ILogger log)
    log.LogInformation("RunAvailabilityTestAsync - Started.");
    var httpClient = _httpClientFactory.CreateClient();
    httpClient.DefaultRequestHeaders.Authorization =
        new AuthenticationHeaderValue("Basic", webJobAuthenticationToken);
    var webJobResponseJson = await httpClient.GetStringAsync(webJobRESTEndpoint);
    var webJobResponse = JsonSerializer.Deserialize<WebJobResponse>(webJobResponseJson);
    if (!webJobResponse.LatestRun.Status.Equals("Success", StringComparison.OrdinalIgnoreCase))
        throw new Exception("Latest Run status is not success.");

WebJobResponse class is the POCO implementation of REST endpoint response. You can convert the JSON response to POCO using or using Visual Studio. Now you can run the function and verify the status of the Web Job.

Application Insights - Failures

This way you can create and run custom availability tests using Azure Functions. Similar to Application Insights availability tests you can configure alerts. As the location is null it is showing empty in the availability blade. If you host it on Azure Functions, the location variable will be auto populated.

  1. Create and run custom availability tests using Azure Functions

Happy Programming :)

Copyright © 2024 Anuraj. Blog content licensed under the Creative Commons CC BY 2.5 | Unless otherwise stated or granted, code samples licensed under the MIT license. This is a personal blog. The opinions expressed here represent my own and not those of my employer. Powered by Jekyll. Hosted with ❤ by GitHub