Jay Sikkeland

Custom Behaviors Pilot Instructions

Blog Post created by Jay Sikkeland Employee on Jul 5, 2017

We are enabling Custom Behaviors for a few customers and partners to give us feedback on the new functionality before we roll it out to all customers.


If you are part of the pilot, please follow these instructions to start using the Custom Behaviors.

If you are not part of the pilot, just wait for the General Availability announcement, or check with your account team if you can be part of the pilot.  Keep in mind we have a limited number of pilot slots open.


Submitting Custom Behaviors during the Pilot Phase.


During this phase, there is no internal UI for the Akamai account team to ingest/submit custom behaviors, so they need to be submitted by the account team via the custom behavior ingest form.


Pilot Phase - Known Issues

The following are known issues, that will be fixed prior to the GA release or in some cases deferred to a future release. 


  • Manual ingest process.
    • We are building a UI for your account team to enable and manage Custom Behaviors for your account without any involvement from engineering/product.  This UI will be in place prior to the GA.
  • Single line description field.
    • The Custom Behavior and Custom Override Rule description fields currently only display a single line of text.  They will be converted to multi line text fields prior to GA.
  • Custom Override Rule and Advanced Override Rule.
    • Currently you have one or the other, but not both together.  We plan on allowing both before the GA, with the Advanced Override Rule getting the final word (executing last).
  • Documentation.
    • Property Manager Help will get a chapter on Custom Behaviors prior to GA.  For now, please refer to the Custom Behavior blog post.
  • Custom behavior upgrade.
    • Upgrading a Custom Behavior is not supported.  If you need to edit a custom behavior, you need to delete the existing Custom Behavior (or Custom Override Rule) and create a new one.
  • Partner level sharing.
    • The pilot does not initially support creating Custom Behaviors in the partner account and sharing them across all the indirect/sub accounts.
    • The workaround is to create duplicate Custom Behaviors in each of the indirect/sub accounts.
    • Partner level sharing will be enabled prior to GA.
  • Advanced Matches
    • We will be adding 4 additional Property Manager matches as part of the Custom Behaviors module before the GA, including:
      • <match:request.type>
      • <match:metadata-stage>
      • <match:regex>
      • <match:request.method>
        • Add AKAMAI_TRANSLATE to list and allow multi-select "is one of" and "is not one of"


If you find other issues during the pilot, please report them to your account team or to jsikkela@akamai.com.  Please include expected vs observed behavior and the exact steps to reproduce the issue.



Working with your Akamai account team, do the following before you start submitting Custom Behaviors.


1 - See if the advanced metadata functionality can be implemented using regular Property Manager (PM) behaviors. Especially with the advent of PM variables, you can do a lot of things with variables + behaviors, that you previously had to use advanced metadata for. This is especially true for configs upgraded from Config Manager.


2 - Break the metadata into discrete pieces of functionality, one custom behavior for each. We don't want 1000 lines of metadata that does 10 different things. Instead identify 10 custom behaviors with 100 lines each. And for each discrete piece of functionality, double check #1 (if you could use regular PM behaviors).


3 - Instrument the metadata with variables where appropriate. Avoid hard coded hostnames, paths, etc and replace them with PMUSER_HOST, PMUSER_PATH, etc. This way the custom behavior can be reused across more configs.


4 - Is it safe? Get an Akamai Senior Solution Architect to review the metadata for any platform safety concerns. Some things that are probably not safe for general use across all customer configs:

  • Turning off persistent connections.
  • Increasing read timeout beyond 5 min.
  • Origin Health Detect.
  • Failover, increasing # of retries.
  • Snippets used for debugging and troubleshooting.


5 - Is it appropriate? Get an Akamai Senior Solution Architect to review the metadata to determine if the functionality is "appropriate".  Not all metadata is designed for all products.  For instance, many web performance related metadata tags are not meant for media downloads or streaming, and vice versa. We will likely add the ability to limit the Custom Behaviors by product or other criteria in the future, but during the pilot we will focus on metadata that can be used across all products.


6 - Custom Behavior vs Custom Override Rule. Most advanced metadata can be used anywhere in a config and is therefore appropriate for a Custom Behavior.  Advanced metadata that has to execute last in the config is located in the Advanced Override Rule and should be implemented as a Custom Override Rule (limited to only one per config)


If you are part of the pilot, please ask your account team to fill out the custom behavior ingest form for each custom behavior or custom override rule you need.