The enableLogCollectorInstanceDebugLogging() GraphQL mutation may be used to enable logging of LogCollector instances for debugging.

To disable debug logging for instances, use disableLogCollectorInstanceDebugLogging(). To enable and disable overall Log Collector debug logging, you can use the enableLogCollectorDebugLogging() and disableLogCollectorDebugLogging() mutations.

API Stability Short-Term

Syntax

graphql
enableLogCollectorInstanceDebugLogging(
      id: string!, 
      url: string, 
      token: string!, 
      level: string!, 
      repositoryName: string
   ): boolean

You'll have to give the unique identifier of the LogCollector instance, the debugging level, the LogCollector URL, the repository name, and the access token. See the Given Datatype section for more details.

For the results, you'll receive confirmation if successful.

Example

Raw
graphql
mutation {
  enableLogCollectorInstanceDebugLogging(
      id: "abc123"
      url: "https://lc.company.com", 
      token: "123abc456def789", 
      level: "high", 
      repositoryName: "humio"
   )
}
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 {
  enableLogCollectorInstanceDebugLogging(
      id: \"abc123\"
      url: \"https://lc.company.com\", 
      token: \"123abc456def789\", 
      level: \"high\", 
      repositoryName: \"humio\"
   )
}"
}
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 {
  enableLogCollectorInstanceDebugLogging(
      id: \"abc123\"
      url: \"https://lc.company.com\", 
      token: \"123abc456def789\", 
      level: \"high\", 
      repositoryName: \"humio\"
   )
}"
}
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 { ^
  enableLogCollectorInstanceDebugLogging( ^
      id: \"abc123\" ^
      url: \"https://lc.company.com\",  ^
      token: \"123abc456def789\",  ^
      level: \"high\",  ^
      repositoryName: \"humio\" ^
   ) ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  enableLogCollectorInstanceDebugLogging(
      id: \"abc123\"
      url: \"https://lc.company.com\", 
      token: \"123abc456def789\", 
      level: \"high\", 
      repositoryName: \"humio\"
   )
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "mutation {
  enableLogCollectorInstanceDebugLogging(
      id: \"abc123\"
      url: \"https://lc.company.com\", 
      token: \"123abc456def789\", 
      level: \"high\", 
      repositoryName: \"humio\"
   )
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
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 {
  enableLogCollectorInstanceDebugLogging(
      id: \"abc123\"
      url: \"https://lc.company.com\", 
      token: \"123abc456def789\", 
      level: \"high\", 
      repositoryName: \"humio\"
   )
}"
}'''

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 {
  enableLogCollectorInstanceDebugLogging(
      id: \"abc123\"
      url: \"https://lc.company.com\", 
      token: \"123abc456def789\", 
      level: \"high\", 
      repositoryName: \"humio\"
   )
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  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": {
    "enableLogCollectorInstanceDebugLogging": true
  }
}

Given Datatype

For the input, you would give the unique identifier of the Log Collector instance, the debugging level, the URL, the repository name, and the access token. The table below lists these parameters:

Table: Input Using Standard Datatypes

Parameter Type Required Default Description
id string yes   The unique identifier of the Log Collector instance.
level string yes   The debugging level.
repositoryName string     The name of the repository.
token string yes   The LogCollector token.
url string     The URL for the LogCollector.