Solution for onboarding Kubernetes/AKS workloads onto Application Insights monitoring.

License: MIT License

Shell 4.96% TypeScript 74.69% Dockerfile 0.49% Batchfile 0.93% Smarty 0.40% Java 2.49% Go 14.59% JavaScript 1.44%

application-insights-k8s-codeless-attach's Introduction

Purpose

Allow Kubernetes deployed application written in Java, Node.JS, .Net Core to export telemetry to Azure Application Insights without the need for the application to be instrumented using the Azure SDK.

How

By deploying agents ( a.k.a libraries ) that are loaded at runtime by the framework underlining the application, data can be uploaded to the customer specified application insights resource. The agents are transparently injected at deploy time by leveraging Kubernetes mutating web hooks, to update the deployment definition of the container.

For existing deployments the webhook will update the pods on restart, or redeploy. Since we do not have visibility into the purpose of deployements, in order to avoid creating problems, we do not interfere with running pods.

High level workflow description

A developer deploys the an new app to a kubernetes cluster, previously configured as explained in the next section.

As the application gets deployed to the desired namespace, the mutating web hook gets invoked by Kubernetes with the deployment document as one of the invocation parameters.

The mutating web hook first performs validation on the document to ensure that it can be updated with the agents information.

After the validation passes, the following information is added to the deployment document :

1. environment variables instructing the frameworks to load the agents. 
2. instructions how to mount the agent binaries
2. configuration for the agents regarding which Application Insights resource to push data to

All this information is returned to Kubernetes as a response to the call, in the form of a JSON patch.

From here the deployment proceeds as normal and the pod is initialized with the extra added environment variables.

Setup

Setting it up

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

application-insights-k8s-codeless-attach's People

Contributors

Stargazers

Watchers

Forkers

selvasingh keyoke cadullms bhaskers-blu-org2 taffywrinkle cifuab claudiusgonzo seenu433 smrama scallighan test-mass-forker-org-1 mreffatti chanted3 codepic ganga1980 cloudfyy ramanujbhattacharjee93

application-insights-k8s-codeless-attach's Issues

Anyone looking at pull requests?

Hi Team,

I have raised a pull request for a fix to an incorrect namespace. I am new and hence I dont know the process to follow for adding reviewers. Unfortunately I could not add anyone. If someone is looking through issues, please approve and merge the pull request.

Best regards

I believe it would be good to include the name of the actual sofware in the name (and directory structure) of the release file, e.g. application_insights_k8s_codeless_attach-0.8.4.tgz. Helm is something I download from somewhere else...
The files are not added in a directory structure, instead they're including the \ character in the filename. This might work if you exctract them on windows, but I get a number of files in the output directory, with "funny" filenames
The files are added with incorrect dates. I'm guessing epoch 0 is being used, as they are shown as 1 jan 1970 on my computer

Project doesn't work with recent AKS versions

Hello,

is this project adapted to kubernetes 1.17 onwards?
First of all, I had to correct webhook-app.yaml in helm chart to replace "apps/v1beta" by "apps/v1" .

Then after installation, I'm noticing that the mutator logs errors:

[2020-08-11T08:55:24.123] [INFO] default - attempting to get owner info
[2020-08-11T08:55:24.123] [INFO] default - calling API with namespace default and replicaset angularnodejs-webapp-7674cb45b5
[2020-08-11T08:55:24.129] [INFO] default - failed to get extra data error {"response":{"statusCode":404,"body":{"kind":"Status","apiVersion":"v1","metadata":{},"status":"Failure","message":"the server could not find the requested resource","reason":"NotFound","details":{},"code":404},"headers":{"audit-id":"918f3589-4849-486f-9316-1f49a89d346f","cache-control":"no-cache, private","content-type":"application/json","date":"Tue, 11 Aug 2020 08:55:24 GMT","content-length":"174","connection":"close"},"request":{"uri":{"protocol":"https:","slashes":true,"auth":null,"host":"10.231.1.1:443","port":"443","hostname":"10.231.1.1","hash":null,"search":null,"query":null,"pathname":"/apis/apps/v1beta2/namespaces/default/replicasets/angularnodejs-webapp-7674cb45b5","path":"/apis/apps/v1beta2/namespaces/default/replicasets/angularnodejs-webapp-7674cb45b5","href":"https://10.231.1.1:443/apis/apps/v1beta2/namespaces/default/replicasets/angularnodejs-webapp-7674cb45b5"}

the api version for replicaset should be "apps/v1" instead of "aps/v1beta2"

what is the status of this project? is it actively maintained? any roadmap to make it GA?

thanks

Update agent version 3.0

Hi.

How i can update to version applicationinsights-agent-3.0.0-PREVIEW.5.jar ? Its posible?

microsoft / application-insights-k8s-codeless-attach Goto Github PK