AppDynamics plugin #674

cloudjumpercat · 2025-03-12T19:42:00Z

Description

Fixes #658

Preview Links

https://deploy-preview-674--kongdeveloper.netlify.app/plugins/app-dynamics/

Questions for reviewers

I didn't convert the intro to a how to since it involves Linux (and I've never worked with VMs) and we don't really have any info about where to find the values in AppDynamic to populate the environment variables. TL;DR: I think I can figure it out, but it's going to take more time than I think we should set aside for this in the migration. I can create a post-GA issue for it.
I removed the "supported platforms" section from the original since AppDynamics covers the details in the doc I linked and I'm not sure we want to repeat all the details about glibc 2.5+ etc. Thoughts?

Checklist

Every page is page one.
Tested how-to docs. If not, note why here. I tested that the example worked
All pages contain metadata.
Updated sources.yaml. For more info, review track docs changes
Any new docs link to existing docs.
All autogenerated instructions render correctly (API, decK, Konnect, Kong Manager).
Style guide (capitalized gateway entities, placeholder URLs) implemented correctly.

Signed-off-by: Diana <[email protected]>

netlify · 2025-03-12T19:42:16Z

✅ Deploy Preview for kongdeveloper ready!

Name	Link
🔨 Latest commit	`f486c52`
🔍 Latest deploy log	https://app.netlify.com/sites/kongdeveloper/deploys/67d1ef26354fdf0008fb9556
😎 Deploy Preview	https://deploy-preview-674--kongdeveloper.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Signed-off-by: Diana <[email protected]>

app/_kong_plugins/app-dynamics/index.md

lena-larionova · 2025-03-12T20:23:07Z

app/_kong_plugins/app-dynamics/examples/example.yaml

I'd rename this page to something like enable-app-dynamics.yaml. Even if there's nothing specific to configure, that makes a better URL than /examples/example.

lena-larionova · 2025-03-12T20:25:19Z

app/_kong_plugins/app-dynamics/examples/example.yaml

+requirements: 
+- "Before using the plugin, download and install the AppDynamics C/C++ Application Agent and SDK on [Linux](https://docs.appdynamics.com/appd/23.x/latest/en/application-monitoring/install-app-server-agents/c-c++-sdk/install-the-c-c++-sdk-on-linux) or [Windows](https://docs.appdynamics.com/appd/23.x/latest/en/application-monitoring/install-app-server-agents/c-c++-sdk/install-the-c-c++-sdk-on-windows) on the machine or within the container running {{site.base_gateway}}."
+- "Set `plugins=bundled,app-dynamics` in [`kong.conf`](/gateway/configuration/) before starting {{site.base_gateway}}"
+- "Configure the AppDynamic plugin [environment variables](/plugins/app-dynamics/#plugin-configuration)"


Suggested change

- "Configure the AppDynamic plugin [environment variables](/plugins/app-dynamics/#plugin-configuration)"

- "Configure the AppDynamics plugin [environment variables](/plugins/app-dynamics/#plugin-configuration)"

lena-larionova · 2025-03-12T20:27:01Z

app/_kong_plugins/app-dynamics/index.md

+  - analytics
+  - monitoring


Suggested change

- analytics

- monitoring

- analytics-monitoring

tags:

- analytics

- monitoring

The category expects analytics-monitoring to sort the plugins in the right place in the plugin hub: https://deploy-preview-674--kongdeveloper.netlify.app/plugins/?category=analytics-monitoring

You can add these add individual tags though.

lena-larionova · 2025-03-12T20:28:19Z

app/_kong_plugins/app-dynamics/index.md

+
+* **Package install:** Set `plugins=bundled,app-dynamics` in [`kong.conf`](/gateway/configuration/) before starting {{site.base_gateway}}
+* **Docker:** Set `export KONG_PLUGINS=bundled,app-dynamics` in the environment
+* **Kubernetes:** Set `KONG_PLUGINS=bundled,app-dynamics` using these instructions


What are "these instructions"?

lena-larionova · 2025-03-12T20:29:02Z

app/_kong_plugins/app-dynamics/index.md

+for more information about the configuration parameters.
+
+{:.info}
+> All non-default environment variables in the table **must** be set.


Can we make them required instead, and label them that way?

lena-larionova · 2025-03-12T20:33:24Z

app/_kong_plugins/app-dynamics/index.md

+| `KONG_APPD_CONTROLLER_CERTIFICATE_FILE` | Path to a self-signed certificate file. For example, `/etc/kong/certs/ca-certs.pem`. <br><br>_Available starting in {{site.base_gateway}} 3.4.3.3_ | String | | 
+| `KONG_APPD_CONTROLLER_CERTIFICATE_DIR` | Path to a certificate directory. For example, `/etc/kong/certs/`. <br><br> _Available starting in {{site.base_gateway}} 3.4.3.3_ | String | | 
+| `KONG_APPD_CONTROLLER_CERTIFICATE_FILE` | Path to a self-signed certificate file. For example, `/etc/kong/certs/ca-certs.pem`. <br><br>_Available starting in {{site.base_gateway}} 3.6.x_ | String | | 
+| `KONG_APPD_CONTROLLER_CERTIFICATE_DIR` | Path to a certificate directory. For example, `/etc/kong/certs/`. <br><br>_Available starting in {{site.base_gateway}} 3.6.x_ | String | | 


Suggested change

| `KONG_APPD_CONTROLLER_CERTIFICATE_FILE` | Path to a self-signed certificate file. For example, `/etc/kong/certs/ca-certs.pem`. _Available starting in {{site.base_gateway}} 3.4.3.3_ | String | |

| `KONG_APPD_CONTROLLER_CERTIFICATE_DIR` | Path to a certificate directory. For example, `/etc/kong/certs/`. _Available starting in {{site.base_gateway}} 3.4.3.3_ | String | |

| `KONG_APPD_CONTROLLER_CERTIFICATE_FILE` | Path to a self-signed certificate file. For example, `/etc/kong/certs/ca-certs.pem`. _Available starting in {{site.base_gateway}} 3.6.x_ | String | |

| `KONG_APPD_CONTROLLER_CERTIFICATE_DIR` | Path to a certificate directory. For example, `/etc/kong/certs/`. _Available starting in {{site.base_gateway}} 3.6.x_ | String | |

| `KONG_APPD_CONTROLLER_CERTIFICATE_FILE` | Path to a self-signed certificate file. For example, `/etc/kong/certs/ca-certs.pem`. _Available starting in {{site.base_gateway}} 3.4.3.3_ | String | |

| `KONG_APPD_CONTROLLER_CERTIFICATE_DIR` | Path to a certificate directory. For example, `/etc/kong/certs/`. _Available starting in {{site.base_gateway}} 3.4.3.3_ | String | |

I can't see any difference between these. I'm guessing it was probably a backport that created some dupe table entries/version tags.

lena-larionova · 2025-03-12T20:34:09Z

app/_kong_plugins/app-dynamics/index.md

+
+## Agent logging
+
+The AppDynamics agent sorts log information into separate log files, independent of {{site.base_gateway}}.


Suggested change

The AppDynamics agent sorts log information into separate log files, independent of {{site.base_gateway}}.

The AppDynamics agent sorts log information into separate log files, independent of {{site.base_gateway}} logs.

lena-larionova · 2025-03-12T20:34:24Z

app/_kong_plugins/app-dynamics/index.md

+## AppDynamics node name considerations
+
+The AppDynamics plugin sets the `KONG_APPD_NODE_NAME` to the local
+host name by default, which typically reflects the container ID of the containerized


Suggested change

host name by default, which typically reflects the container ID of the containerized

hostname by default, which typically reflects the container ID of the containerized

lena-larionova · 2025-03-12T20:34:38Z

app/_kong_plugins/app-dynamics/index.md

+The AppDynamics plugin sets the `KONG_APPD_NODE_NAME` to the local
+host name by default, which typically reflects the container ID of the containerized
+application. Multiple instances of the AppDynamics agent must use
+different node names, and one agent must exists for each of {{site.base_gateway}}'s


Suggested change

different node names, and one agent must exists for each of {{site.base_gateway}}'s

different node names, and one agent must exist for each of {{site.base_gateway}}'s

cloudjumpercat added 2 commits March 12, 2025 13:18

Start drafting

77bdbb3

Signed-off-by: Diana <[email protected]>

Finish drafting app dynamics

9a25a72

Signed-off-by: Diana <[email protected]>

Appease Vale

bd43ad3

Signed-off-by: Diana <[email protected]>

cloudjumpercat marked this pull request as ready for review March 12, 2025 19:53

cloudjumpercat requested a review from a team as a code owner March 12, 2025 19:53

Remove if_version, fix some formatting and example prereq

dba7664

Signed-off-by: Diana <[email protected]>

cloudjumpercat commented Mar 12, 2025

View reviewed changes

app/_kong_plugins/app-dynamics/index.md Outdated Show resolved Hide resolved

fix category

f486c52

lena-larionova requested changes Mar 12, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

AppDynamics plugin #674

AppDynamics plugin #674

cloudjumpercat commented Mar 12, 2025 •

edited

Loading

netlify bot commented Mar 12, 2025 •

edited

Loading

lena-larionova Mar 12, 2025

lena-larionova Mar 12, 2025

lena-larionova Mar 12, 2025

lena-larionova Mar 12, 2025

lena-larionova Mar 12, 2025

lena-larionova Mar 12, 2025

lena-larionova Mar 12, 2025

lena-larionova Mar 12, 2025

lena-larionova Mar 12, 2025

	- "Configure the AppDynamic plugin [environment variables](/plugins/app-dynamics/#plugin-configuration)"
	- "Configure the AppDynamics plugin [environment variables](/plugins/app-dynamics/#plugin-configuration)"


		## Agent logging

		The AppDynamics agent sorts log information into separate log files, independent of {{site.base_gateway}}.

	host name by default, which typically reflects the container ID of the containerized
	hostname by default, which typically reflects the container ID of the containerized

	different node names, and one agent must exists for each of {{site.base_gateway}}'s
	different node names, and one agent must exist for each of {{site.base_gateway}}'s

AppDynamics plugin #674

Are you sure you want to change the base?

AppDynamics plugin #674

Conversation

cloudjumpercat commented Mar 12, 2025 • edited Loading

Description

Preview Links

Questions for reviewers

Checklist

netlify bot commented Mar 12, 2025 • edited Loading

✅ Deploy Preview for kongdeveloper ready!

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cloudjumpercat commented Mar 12, 2025 •

edited

Loading

netlify bot commented Mar 12, 2025 •

edited

Loading