Merge pull request #2971 from aws-observability/featureflag

Add configuration support for feature flag in linux script

Author: vasireddy99

.github/scripts/test-collector-ctl.sh

@@ -86,10 +86,18 @@ test_collector_ctl_with_samecfg_restart() {
     echo "${FUNCNAME[0]} ... OK"
 }
 
+test_collector_ctl_with_featureflag() {
+    #staart coll default conf by starting without -c
+    $ADOT_CTL -a start -f "-adot.exporter.datadogexporter.deprecation"
+
+    echo "${FUNCNAME[0]} ... OK"
+}
+
 setup
 
 ## Tests
 test_collector_ctl_does_not_overwrite_env
 test_collector_ctl_with_sed_special_chars
 test_collector_ctl_with_samecfg
 test_collector_ctl_with_samecfg_restart
+test_collector_ctl_with_featureflag

tools/ctl/linux/aws-otel-collector-ctl.sh

@@ -27,14 +27,16 @@ SYSTEMD='false'
 
 UsageString="
 
-  usage: aws-otel-collector-ctl -a stop|start|status| [-c <config-uri>]
+  usage: aws-otel-collector-ctl -a stop|start|status| [-c <config-uri>] [-f <feature-gate>]
 
   e.g.
-  1. start collector on onPermise host with a custom .yaml config file:
+  1. start collector on onPremise host with a custom .yaml config file:
   sudo aws-otel-collector-ctl -c /tmp/config.yaml -a start
-  2. stop the running collector
+  2. start collector on onPremise host using featuregate:
+  sudo aws-otel-collector-ctl -c /tmp/config.yaml -f +adot.example.featuregate -a start
+  3. stop the running collector
   sudo aws-otel-collector-ctl -a stop
-  3. query agent status:
+  4. query agent status:
   sudo aws-otel-collector-ctl -a status
 
   -a: action
@@ -48,6 +50,10 @@ UsageString="
                                           - https uri. E.g.: https://example.com/config
                                           - s3 uri. E.g.: s3://bucket/config
 
+  -f: feature-gate
+  <feature-gates>                         - enable or disable feature gate
+                                          - E.g.: Enabling : +adot.example.featuregate
+                                          - disabling : -adot.example.featuregate
   "
 
 aoc_config_remote_uri() {
@@ -80,6 +86,16 @@ aoc_config_local_uri() {
     fi
 }
 
+aoc_config_feature_gates() {
+    feature_gates="${1:-}"
+
+    sed -i '/^feature_gates=.*$/d' $ENV_FILE
+    if [ -n "$feature_gates" ]; then
+        echo "feature_gates=\"--feature-gates='${feature_gates}'\"" >> $ENV_FILE
+    fi
+}
+
+
 # Used in case the collector starts for the first time without a configuration parameter
 # Safe to run as this will not overwrite a file if one exists in default location already.
 aoc_ensure_default_config() {
@@ -100,6 +116,7 @@ is_remote_uri() {
 
 aoc_start() {
     config="${1:-}"
+    feature_gates="${2:-}"
 
     # The previous configuration should be used if no configuration parameter is passed
     aoc_ensure_default_config
@@ -111,6 +128,11 @@ aoc_start() {
         fi
     fi
 
+    # Handle feature gates
+    if [ -n "$feature_gates" ]; then
+        aoc_config_feature_gates "$feature_gates"
+    fi
+
     if [ "${SYSTEMD}" = 'true' ]; then
         systemctl daemon-reload
         systemctl enable aws-otel-collector.service
@@ -190,6 +212,7 @@ main() {
     action=''
     mode='ec2'
     config_location=''
+    feature_gates=''
 
     # detect which init system is in use
     if [ "$(/sbin/init --version 2>/dev/null | grep -c upstart)" = 1 ]; then
@@ -205,7 +228,7 @@ main() {
     fi
 
     OPTIND=1
-    while getopts ":ha:c:m:" opt; do
+    while getopts ":ha:c:m:f:" opt; do
         case "${opt}" in
         h)
             echo "${UsageString}"
@@ -214,6 +237,7 @@ main() {
         a) action="${OPTARG}" ;;
         c) config_location="${OPTARG}" ;;
         m) mode="${OPTARG}" ;;
+        f) feature_gates="${OPTARG}" ;;
         \?)
             echo "Invalid option: -${OPTARG} ${UsageString}" >&2
             ;;
@@ -240,7 +264,7 @@ main() {
 
     case "${action}" in
     stop) aoc_stop ;;
-    start) aoc_start "${config_location}" ;;
+    start) aoc_start "${config_location}" "${feature_gates}" ;;
     status) aoc_status ;;
     # helper for rpm+deb uninstallation hooks, not expected to be called manually
     preun) aoc_preun ;;

tools/ctl/windows/aws-otel-collector-ctl.ps1

@@ -19,6 +19,8 @@ Param (
     [Parameter(Mandatory = $false)]
     [string]$ConfigLocation = 'default',
     [Parameter(Mandatory = $false)]
+    [string]$FeatureGates,
+    [Parameter(Mandatory = $false)]
     [switch]$Start = $false,
     [Parameter(Mandatory = $false)]
     [string]$Mode = 'ec2',
@@ -37,9 +39,11 @@ $UsageString = @"
         e.g.
         1. start collector with a custom .yaml config file:
             aws-otel-collector-ctl.ps1 -c /tmp/config.yaml -a start
-        2. stop the running collector:
+        2. start collector with a custom .yaml config file:
+            aws-otel-collector-ctl.ps1 -f +adot.example.featuregate -a start
+        3. stop the running collector:
             aws-otel-collector-ctl.ps1 -a stop
-        3. query agent status:
+        4. query agent status:
             aws-otel-collector-ctl.ps1 -a status
 
         -a: action
@@ -52,6 +56,10 @@ $UsageString = @"
             - http uri. E.g.: http://example.com/config
             - https uri. E.g.: https://example.com/config
             - s3 uri. E.g.: s3://bucket/config
+        -f: <feature-gates>
+            - enable or disable feature gates
+            - E.g.: Enabling: "+adot.example.featuregate"
+            - disabling: "-adot.example.featuregate"
 
 "@
 
@@ -81,19 +89,40 @@ Function Get-Service-Config-Uri() {
     return $Matches.1
 }
 
+
+
 Function Set-Service-Config-Uri ([string]$uri) {
     $aoc_cmd = "\""${AOCProgramFiles}\.aws-otel-collector.exe\""  --config=\""${uri}\"""
     sc.exe config "${AOCServiceName}" binPath= "${aoc_cmd}"
 }
 
+Function Set-Service-Config-Uri-With-FeatureGates ([string]$uri, [string]$featureGates) {
+    Write-Output "Applying feature gate ${featureGates} "
+    $aoc_cmd = "\""${AOCProgramFiles}\.aws-otel-collector.exe\""  --config=\""${uri}\"" --feature-gates=\""${featureGates}\"""
+    sc.exe config "${AOCServiceName}" binPath= "${aoc_cmd}"
+}
+
 Function Test-Remote-Uri ([string]$uri) {
     return $uri -match "^[a-zA-Z0-9]+://" -and $uri -notmatch "^file:"
 }
 
 Function AOCStart() {
 
     if($ConfigLocation -and $ConfigLocation -ne 'default') {
+
+    # Check for feature gates before configuring service
+    if ($FeatureGates) {
+        Write-Output "Applying feature gate"
         if (Test-Remote-Uri $ConfigLocation) {
+           Set-Service-Config-Uri-With-FeatureGates ${ConfigLocation} ${FeatureGates}
+        } else {
+            # Strip file scheme in case it is present
+            $ConfigLocation = "$ConfigLocation" -replace "^file:", ""
+
+            Copy-Item "${ConfigLocation}" -Destination ${ProgramFilesYAML}
+            Set-Service-Config-Uri-With-FeatureGates ${ProgramFilesYAML} ${FeatureGates}
+        }
+    } elseif (Test-Remote-Uri $ConfigLocation) {
             Set-Service-Config-Uri ${ConfigLocation}
         } else {
             # Strip file scheme in case it is present
@@ -121,6 +150,7 @@ Function AOCStart() {
             & sc.exe failureflag "${AOCServiceName}" 1 | Out-Null
         }
     }
+
     $svc | Start-Service
 }
 
@@ -131,7 +161,6 @@ Function AOCStop() {
     }
 }
 
-
 Function AOCStatus() {
 
     $timefmt=''
@@ -150,18 +179,18 @@ Function AOCStatus() {
             $timefmt = Get-Date -Date ${processStart} -Format "s"
         }
     }
-    
+
     $status = AOCRunstatus
     $version = ([IO.File]::ReadAllText("${VersionFile}")).Trim()
-    
+
     Write-Output "{"
     Write-Output "  `"status`": `"${status}`","
     Write-Output "  `"starttime`": `"${timefmt}`","
     Write-Output "  `"version`": `"${version}`""
     Write-Output "}"
 }
 
-# Translate platform status names to those used across all AOCgent's platforms
+# Translate platform status names to those used across all AOCAgent's platforms
 Function AOCRunstatus() {
     $running = $false
     $svc = Get-Service -Name "${AOCServiceName}" -ErrorAction SilentlyContinue