In the LogScale user interface, preferred fields in a repository can be shown at the top of the list of fields by adding a star next to them. This helps bring key fields to the user's attention. To add a star to a field, use the addStarToField() GraphQL mutation.

To get a list of fields that may be starred, you'll have to use the fieldset() function in a query ‐ data management is outside of the GraphQL API. To remove a star from a repository field, use the removeStarFromField() GraphQL mutation.

Hide Query Example

Show Starred Fields Query

For more information on fields, see the Event Fields documentation page.

API Stability Long-Term

Syntax

graphql
addStarToField(
      input: AddStarToFieldInput!
   ): AddStarToFieldMutation!

For the input, you have to give the name of the repository or view, and the name of the field you want to star. See the Given Datatype section for details.

For the results, you can get a list of fields that have been starred. See the Returned Datatype section farther down this page.

Show Starred Fields Query

Example

Raw
graphql
mutation {
  addStarToField(input: 
       { fieldName: "connectionSource"
         searchDomainName: "humio" } )
  { starredFields }
}
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 {
  addStarToField(input: 
       { fieldName: \"connectionSource\"
         searchDomainName: \"humio\" } )
  { starredFields }
}"
}
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 {
  addStarToField(input: 
       { fieldName: \"connectionSource\"
         searchDomainName: \"humio\" } )
  { starredFields }
}"
}
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 { ^
  addStarToField(input:  ^
       { fieldName: \"connectionSource\" ^
         searchDomainName: \"humio\" } ) ^
  { starredFields } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  addStarToField(input: 
       { fieldName: \"connectionSource\"
         searchDomainName: \"humio\" } )
  { starredFields }
}"
}'
    "$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 {
  addStarToField(input: 
       { fieldName: \"connectionSource\"
         searchDomainName: \"humio\" } )
  { starredFields }
}";
$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 {
  addStarToField(input: 
       { fieldName: \"connectionSource\"
         searchDomainName: \"humio\" } )
  { starredFields }
}"
}'''

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 {
  addStarToField(input: 
       { fieldName: \"connectionSource\"
         searchDomainName: \"humio\" } )
  { starredFields }
}"
}
);


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": {
    "addStarToField": {
      "starredFields": [
        "@timestamp",
        "connectionSource"
      ]
    }
  }
}

Given Datatype

For this datatype, you'll have to give the name of the search domain, and the name of the field you want to mark with a star. These parameters are listed and described in the table here:

Table: AddStarToFieldInput

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 17, 2024
fieldNamestringyes Long-TermThe name of the field to mark with a star.
searchDomainNamestringyes Long-TermThe search domain where the field can be found.

Returned Datatype

This datatype returns a list of fields that have been marked with stars. This can be useful in case you want to remove some or add more.

Table: AddStarToFieldMutation

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 23, 2024
starredFields[string]yes Long-TermThe fields on which to add stars.