cancel
Showing results for 
Show  only  | Search instead for 
Did you mean: 

Extensions 2.0 - Is there detailed documentation on the activationSchema.json file and ALL of its possible fields and values?

36Krazyfists
Helper

I can find info on the extension.yaml file, but very little about activationSchema.json...  Given how important this file seems to be, I would think this has to be documented somewhere, right?

 

The most I found was on the dt-extensions-python-sdk page and it confuses me greatly.  It seems to insinuate that the Create command of the python-sdk will generate the Activation Schema file automatically.  However, I'm looking at the rabbitMQ Python extension's ActivationSchema.json file and I see things defined in it that I have a hard time believing were filled out automatically based on data it has collected from the script.  Not to mention that there is a python method for getting the contents of the activationSchema.json file, so how can the activationSchema.json file be automatically generated based on script contents if the script needs to get data from the file itself?

We need documentation that details the following:
- Are the activationSchema.json file contents completely automated, or are we supposed to be configuring it?

- What do the fields in this file do and what are all of the possible values for each field?

- And, most importantly, why would we use a field?  This is something that is missing from a lot of Dynatrace's documentation (not all, some sections are pretty good).  Meaning that, even when they explain what something is, I still have no clue what it does or why I would use it (for example, fastCheck...  The only place I've seen it explained is in the context of the SNMP extension, but I see it used in Python extensions and I don't know how or why to use it...).

12 REPLIES 12

Mike_L
Dynatrace Guru
Dynatrace Guru

There is currently no documentation for this. I'll forward your thread to the product manager.

Mike

Yes please!

Hi.  Is there at least a schema file somewhere for the activationSchema.json file?  I want to know what the possible fields and values are that can be used there (yes, I can look at other extensions' activationSchema files, but that still doesn't give me a complete picture, nor does it give me a real explanation of what and why something is used).

 

I've looked in the /v2/extensions/schema api endpoint and there doesn't appear to be a schema file that explains the activationSchema.json file.

 

I've also found this link at the top of the activationSchema.json files of a few extensions developed by Dynatrace (like the newer forgerock identity cloud extension for example), but this link doesn't appear to be publicly accessible:
https://artifactory.lab.dynatrace.org/artifactory/configuration-core-release/com/dynatrace/configura...

 

I'm looking back at some of the documentation for the old EF1.0 and it is pretty fantastic.  Is there any plan to get that level of detail for the 2.0 framework?  It's been a while and still nothing.  But honestly, I'll just take a schema file for that activationSchema.json file at this point...  Just... something...

Hi Mike.  Any word on this yet?  It's been almost a year (and extensions 2.0 has been around for several more years prior to that) and we still don't have proper documentation (that I can find) on the activationSchema.json file...

 

Sure, looking at other extensions can help, but ultimately we need to know what should/can be in there and how to use it to write good python extensions.  Currently, we're all just kind of winging it.

 

Using the vsCode extension can help because it will show some auto-complete, but that still isn't the same as seeing the whole schema at once to get an understanding of how it all works and ties together.

 

While documentation would be nice, I'd settle for just the schema file at this point...

Let me raise it again with product management.

Mike

Thank you Mike!

Joseph_Hobbs
Contributor

In the meantime, check out this extension (downloadable from the public hub).  Lots of good examples!

https://www.dynatrace.com/hub/detail/remote-unix-monitoring-20/?query=linux+remote&filter=all#overvi...

pahofmann
DynaMight Guru
DynaMight Guru

It's been a while, are there any updates on documentation for this? 

Dynatrace Certified Master - Dynatrace Partner - 360Performance.net

We are about one week before the end of EF1 and we still not have a proper documentation for EF2...
The only solution is to contact support each time we have a question.

Yes, it's quite tedious I have to say.  

The v2 Framework has so many great new features but without documentation it just takes a lot of time. 

I'd recommend looking at the unix remote extension from the hub, can copy a lot of examples from there.

Dynatrace Certified Master - Dynatrace Partner - 360Performance.net

MathieuB
Participant

Hi everyone,
I don't know if anyone watch this topic anymore regarding that it has been marked "solved".

I contact the support team and the final answer is that :

  1. There is no real developer documentation, but there are working on it (without giving any date..)
  2. The only "documentation" they have is that :
    https://developer.dynatrace.com/develop/dynatrace-extensions-vscode/guides/create_extension/#activat...

@pahofmann can you give me the link of the Unix remote extension you talk ? Thanks

So on our side, we cannot migrate to EF2.
We will try to stay on EF1 without any support : now when we contact Dynatrace support on EF1 issue, the only answer we get is "migrate to EF2 Extension".

Featured Posts