API Stability Preview

The enableWorkerQueryTracing() GraphQL mutation may be used to enable query tracing on worker nodes for queries with the given quota key.

Syntax

Below is the syntax for the enableWorkerQueryTracing() mutation field:

graphql
enableWorkerQueryTracing(
      input: EnableWorkerQueryTracingInputType!
   ): boolean

Below is an example of how this mutation field might be used:

Raw
graphql
mutation {
  enableWorkerQueryTracing (input:
    { quotaKey: "abc123",
      expiry: "2025-06-12T00:00:00Z"
    } )
}
Mac OS or Linux (curl)
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  enableWorkerQueryTracing (input:
    { quotaKey: \"abc123\",
      expiry: \"2025-06-12T00:00:00Z\"
    } )
}"
}
EOF
Mac OS or Linux (curl) One-line
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  enableWorkerQueryTracing (input:
    { quotaKey: \"abc123\",
      expiry: \"2025-06-12T00:00:00Z\"
    } )
}"
}
EOF
Windows Cmd and curl
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  enableWorkerQueryTracing (input: ^
    { quotaKey: \"abc123\", ^
      expiry: \"2025-06-12T00:00:00Z\" ^
    } ) ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  enableWorkerQueryTracing (input:
    { quotaKey: \"abc123\",
      expiry: \"2025-06-12T00:00:00Z\"
    } )
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "mutation {
  enableWorkerQueryTracing (input:
    { quotaKey: \"abc123\",
      expiry: \"2025-06-12T00:00:00Z\"
    } )
}"
}';
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";
Python
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  enableWorkerQueryTracing (input:
    { quotaKey: \"abc123\",
      expiry: \"2025-06-12T00:00:00Z\"
    } )
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)
Node.js
javascript
const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  enableWorkerQueryTracing (input:
    { quotaKey: \"abc123\",
      expiry: \"2025-06-12T00:00:00Z\"
    } )
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL/graphql',
  path: '/graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "enableWorkerQueryTracing": true
  }
}

Given Datatypes

For EnableWorkerQueryTracingInputType, there are two straightforward parameters that may be given. They're listed and described below:

Table: EnableWorkerQueryTracingInputType

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Sep 18, 2024
expirydatetimeyes PreviewThe end timestamp for tracing. Tracing for this quota key will be disabled automatically once this time is reached. Will be clamped to be at most 15 minutes in the future.
quotaKeystringyes PreviewThe quota key for which to enable tracing. All queries belonging to this quota key will be traced.