custom dql syntax highlighting support

Author: ibarrajo

docs/07-operation-guide/01-setup.md

@@ -28,7 +28,7 @@ The default directory for configuration files is named **config/**. This directo
 * Availability Zone File: If an availability zone is specified (either through the `$CADENCE_AVAILABILITY_ZONE` environment variable or as a command-line argument), a file named after the zone will be merged. For example, if you specify "az1" as the zone, `production_az1.yaml` will be used as well.
 
 To merge `base.yaml`, `production.yaml`, and `production_az1.yaml` files, you need to specify "production" as the runtime environment and "az1" as the zone.
-```
+```log
 // base.yaml -> production.yaml -> production_az1.yaml = final configuration
 ```
 
@@ -115,7 +115,7 @@ For example, search for "EnableGlobalDomain" in Dynamic Configuration [Comments
   * `N/A` means no filters can be set. The config will be global.
 
 For example, if you want to change the ratelimiting for List API, below is the config:
-```
+```clike
 // FrontendVisibilityListMaxQPS is max qps frontend can list open/close workflows
 // KeyName: frontend.visibilityListMaxQPS
 // Value type: Int
@@ -152,9 +152,9 @@ By default, Cadence uses file-based client to manage dynamic configurations. Fol
 cadence:
   image: ubercadence/server:master-auto-setup
   ports:
-    ...(don't change anything here)
+    # ...(don't change anything here)
   environment:
-    ...(don't change anything here)
+    # ...(don't change anything here)
     - "DYNAMIC_CONFIG_FILE_PATH=/etc/custom-dynamicconfig/development.yaml"
   volumes:
     - "/Users/<?>/cadence/config/dynamicconfig:/etc/custom-dynamicconfig"
@@ -175,7 +175,7 @@ After restarting Cadence instances, execute a command like this to let Cadence l
 `cadence --domain <> workflow list`
 
 Then you should see the logs like below
-```
+```log
 cadence_1        | {"level":"info","ts":"2021-05-07T18:43:07.869Z","msg":"First loading dynamic config","service":"cadence-frontend","key":"frontend.visibilityListMaxQPS,domainName:sample,clusterName:primary","value":"10000","default-value":"10","logging-call-at":"config.go:93"}
 ```
 

docs/07-operation-guide/02-maintain.md

@@ -38,7 +38,7 @@ There are a few things to know when using this feature:
 * Because of above, when scaling down the number of partitions, you must decrease the WritePartitions first, to wait for a certain time to ensure that tasks are drained, and then decrease ReadPartitions.
 * Both domain names and taskListName should be specified in the dynamic config. An example of using this feature. See more details about dynamic config format using file based [dynamic config](/docs/operation-guide/setup/#static-configuration).
 
-```
+```yaml
 matching.numTasklistWritePartitions:
   - value: 10
     constraints:

docs/07-operation-guide/03-monitoring.md

@@ -129,44 +129,44 @@ cadence --address <currentClusterAddress> --do <domain_name> domain update --clu
 
 Run the command below to refresh the domain after adding a new cluster to the cluster list; we need to update the active_cluster to the same value that it appears to be.
 
-```
+```bash
 cadence --address <currentClusterAddress> --do <domain_name> domain update --active_cluster <currentClusterName>
 ```
 
 
 * 2.2 failover the domain to be active in new cluster
-```
+```bash
 cadence --address <currentClusterAddress> --do workflow-prototype domain update --active_cluster <newClusterName>
 ```
 
 Use the domain describe command to verify the entire domain is replicated to the new cluster.
 
-```
+```bash
 cadence --address <newClusterAddress> --do <domain_name> domain describe
 ```
 Find an open workflowID that we want to replicate (you can get it from the UI). Use this command to describe it to make sure it’s open and running:
 
-```
+```bash
 cadence --address <initialClusterAddress> --do <domain_name> workflow describe --workflow_id <wfID>
 ```
 Run a signal command against any workflow and check that it was replicated to the new cluster. Example:
 
-```
+```bash
 cadence --address <initialClusterAddress> --do <domain_name> workflow signal --workflow_id <wfID> --name <anything not functional, e.g. replicationTriggeringSignal>
 ```
 This command will send a noop signal to workflows to trigger a decision, which will trigger history replication if needed.
 
 
 Verify the workflow is replicated in the new cluster
-```
+```bash
 cadence --address <newClusterAddress> --st <adminOperationToken> --do <domain_name> workflow describe --workflow_id <wfID>
 ```
 Also compare the history between the two clusters:
-```
+```bash
 cadence --address <newClusterAddress> --do <domain_name> workflow show --workflow_id <wfID>
 ```
 
-```
+```bash
 cadence --address <initialClusterAddress> --do <domain_name> workflow show --workflow_id <wfID>
 ```
 
@@ -178,7 +178,7 @@ You can repeat Step 2 for all the domains. Or you can use the managed failover f
 Because replication cannot be triggered without a decision. Again best way is to send a garbage signal to all the workflows.
 
 If advanced visibility is enabled, then use batch signal command to start a batch job to trigger replication for all open workflows:
-```
+```bash
 cadence --address <initialClusterAddress> --do <domain_name> workflow batch start --batch_type signal --query “CloseTime = missing” --signal_name <anything, e.g. xdcTest> --reason <anything> --input <anything> --yes
 ```
 
@@ -193,7 +193,7 @@ A few things need to do in order to shutdown the old cluster.
 * Migrate all applications to connect to the frontend of new cluster instead of relying on the forwarding
 * Watch metric dashboard to make sure no any traffic is happening on the old cluster
 * Delete the old cluster from domain cluster list. This needs to be done for every domain.
-```
+```bash
 cadence --address <newHostAddress> --do <domain_name> domain update --clusters <newClusterName>
 ```
 * Delete the old cluster from the configuration of the new cluster.

docs/07-operation-guide/05-migration.md

@@ -303,6 +303,8 @@ const config: Config = {
     prism: {
       theme: prismThemes.github,
       darkTheme: prismThemes.dracula,
+      additionalLanguages: ['go', 'java', 'bash', 'markup', 'json', 'shell-session', 'yaml', 'gradle', 'log',],
+
     },
   } satisfies Preset.ThemeConfig,
 };

docusaurus.config.ts

@@ -0,0 +1,46 @@
+Prism.languages.dql = {
+    // For token definitions: https://prismjs.com/tokens.html
+    // Syntax highlighting for DQL (Data Query Language) used in the DataDog logs
+    'comment': [
+        {
+            pattern: /(^|[^\\])\/\*[\s\S]*?(?:\*\/|$)/,
+            lookbehind: true,
+            greedy: true
+        },
+        {
+            pattern: /(^|[^\\:])\/\/.*/,
+            lookbehind: true,
+            greedy: true
+        }
+    ],
+    'string': {
+        pattern: /(["'])(?:\\(?:\r\n|[\s\S])|(?!\1)[^\\\r\n])*\1/,
+        greedy: true
+    },
+    'class-name': {
+        pattern: /(\b(?:env|service|operation_name|resource_name|status|ingestion_reason|trace_id)\s+|\bcatch\s+\()[\w.\\]+/i,
+        lookbehind: true,
+        inside: {
+            'punctuation': /[.\\]/
+        }
+    },
+    'entity': /\b(?:env|service|operation_name|resource_name|status|ingestion_reason|trace_id)\b/,
+    'keyword': /\b(?:by|in|and|not|count|count\sby|stddev|p\d\d)\b/i,
+    'boolean': /\b(?:false|true)\b/i,
+    'function': /(\b\w+(?=\())|(\w+(?=:))/,
+    'number': /\b0x[\da-f]+\b|(?:\b\d+(?:\.\d*)?|\B\.\d+)(?!\d*percentile)(?:e[+-]?\d+)?/i,
+    'operator': /[<>]=?|[!=]=?=?|--?|\+\+?|&&?|\|\|?|[?*/~^%]|->|=>/i,
+    'punctuation': /[{}[\];(),.:]/,
+    'builtin': {
+        pattern: /\b(\d{2}percentile)\b|\b(avg|max|min|sum|set|median|count|is_greater|is_less|is_between|quantile)\b/i,
+    },
+    'variable': /\$+(?:\w+\b|(?=\{))/,
+};
+
+Prism.languages.insertBefore('dql', 'operator', {
+    'literal-property': {
+        pattern: /((?:^|[,{])[ \t]*)(?!\s)[_$a-zA-Z\xA0-\uFFFF](?:(?!\s)[$\w\xA0-\uFFFF])*(?=\s*:)/m,
+        lookbehind: true,
+        alias: 'property'
+    },
+});

src/theme/prism-dql.js

@@ -0,0 +1,29 @@
+import siteConfig from '@generated/docusaurus.config';
+export default function prismIncludeLanguages(PrismObject) {
+  const {
+    themeConfig: { prism },
+  } = siteConfig;
+  const { additionalLanguages } = prism;
+  // Prism components work on the Prism instance on the window, while prism-
+  // react-renderer uses its own Prism instance. We temporarily mount the
+  // instance onto window, import components to enhance it, then remove it to
+  // avoid polluting global namespace.
+  // You can mutate PrismObject: registering plugins, deleting languages... As
+  // long as you don't re-assign it
+  const PrismBefore = globalThis.Prism;
+  globalThis.Prism = PrismObject;
+  additionalLanguages.forEach((lang) => {
+    if (lang === 'php') {
+      // eslint-disable-next-line global-require
+      require('prismjs/components/prism-markup-templating.js');
+    }
+    // eslint-disable-next-line global-require, import/no-dynamic-require
+    require(`prismjs/components/prism-${lang}`);
+  });
+  require('./prism-dql.js')
+  // Clean up and eventually restore former globalThis.Prism object (if any)
+  delete globalThis.Prism;
+  if (typeof PrismBefore !== 'undefined') {
+    globalThis.Prism = PrismObject;
+  }
+}