https://github.com/wictorwilen/application-insights-action

A Github Action that creates Deployment annoations in Application Insights
https://github.com/wictorwilen/application-insights-action

actions application-insights github

Last synced: 3 months ago
JSON representation

A Github Action that creates Deployment annoations in Application Insights

• Host: GitHub
• URL: https://github.com/wictorwilen/application-insights-action
• Owner: wictorwilen
• License: mit
• Created: 2020-05-23T09:51:43.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-11T07:11:44.000Z (over 2 years ago)
• Last Synced: 2025-03-15T07:17:59.949Z (4 months ago)
• Topics: actions, application-insights, github
• Language: TypeScript
• Homepage:
• Size: 485 KB
• Stars: 9
• Watchers: 1
• Forks: 3
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Application Insights Deploy Annotation Action

A Github Action that creates Deployment annoations in Application Insights

![.github/workflows/test.yml](https://github.com/wictorwilen/application-insights-action/workflows/.github/workflows/test.yml/badge.svg)

This action allows you to add annotations to the Application Insights timeline so that you with ease can correlate any issues or changes to specific deployments.

![Annotation sample](assets/annotation-sample.jpg)

## Setup

You need the *Application Id* for your Application Insights instance as well as an *API key*. These values are found in the *API Access* tab. The *API key* is created by selecting *Create API key* and then typing a description and selecting *Write Annotations*. After selecting *Generate key* you will get the generated *API key*. It is strongly recommended to add these two as [Github secrets](https://help.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) and not reference them directly in your workflow.

## Inputs

The action accepts the following inputs:

* **applicationId** - The Application Id of Application Insights

* **apiKey** - An Application Insights API Key with *Write Annotations* permissions

* **releaseName** - The release name to use in the annotation

* **message** - An optional message

* **actor** - Text to use as created by in the annotation

## Sample configuration

``` yaml

- name: Annotate deployment

  uses: wictorwilen/application-insights-action@v1

  id: annotation

  with:

    applicationId: ${{ secrets.APPLICATION_ID }}

    apiKey: ${{secrets.API_KEY}}

    releaseName: ${{ github.event_name }}

    message: ${{ github.event.head_commit.message }}

    actor: ${{ github.actor }}

```