API Stability Short-Term

The getLogCollectorInstanceDebugLogging() GraphQL query to get a Log Collector instance debugging log.

Syntax

Below is the syntax for the getLogCollectorInstanceDebugLogging() query field:

graphql
getLogCollectorInstanceDebugLogging(
      id: string!
   ): LogCollectorDebugLogging

Below is an example of how you could use this query field:

Raw
graphql
query {
  getLogCollectorInstanceDebugLogging(id: "123") {
     url: "https://company.com",
     token: "abcdef1234", level: "low",
     repository: "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" : "query {
  getLogCollectorInstanceDebugLogging(id: \"123\") {
     url: \"https://company.com\",
     token: \"abcdef1234\", level: \"low\",
     repository: \"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" : "query {
  getLogCollectorInstanceDebugLogging(id: \"123\") {
     url: \"https://company.com\",
     token: \"abcdef1234\", level: \"low\",
     repository: \"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" : "query { ^
  getLogCollectorInstanceDebugLogging(id: \"123\") { ^
     url: \"https://company.com\", ^
     token: \"abcdef1234\", level: \"low\", ^
     repository: \"humio\"} ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  getLogCollectorInstanceDebugLogging(id: \"123\") {
     url: \"https://company.com\",
     token: \"abcdef1234\", level: \"low\",
     repository: \"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 = "query {
  getLogCollectorInstanceDebugLogging(id: \"123\") {
     url: \"https://company.com\",
     token: \"abcdef1234\", level: \"low\",
     repository: \"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" : "query {
  getLogCollectorInstanceDebugLogging(id: \"123\") {
     url: \"https://company.com\",
     token: \"abcdef1234\", level: \"low\",
     repository: \"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" : "query {
  getLogCollectorInstanceDebugLogging(id: \"123\") {
     url: \"https://company.com\",
     token: \"abcdef1234\", level: \"low\",
     repository: \"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();

Returned Datatypes

LogCollectorDebugLogging is a union datatype. At this point, it's composed of one datatype: LogCollectorDebugLoggingStatic. There are a few possible values returned for it.

Table: LogCollectorDebugLoggingStatic

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Sep 26, 2024
levelstringyes Short-TermThe debugging level to log.
repositorystring  Short-TermThe repository for debugging.
tokenstringyes Short-TermThe token used by the Log Collector.
urlstring  Short-TermThe URL for debugging the Log Collector.