API Guide de scénario

Le script « Instana » d' API utilise les variables globales prédéfinies suivantes pour accélérer le développement de scripts :

Pour envoyer une demande GET, utilisez la syntaxe suivante:

const assert = require('assert');
(async function () {
    var options = {
      url: 'https://reqres.in/api/messages',
      https:{ rejectUnauthorized: false }
    };

    // Send GET request
    let response = await $got.get(options);

    // Validate the response status code, it should be 200 here
    assert.ok(response && response.statusCode == 200, 'Expect 200');
})();
 

Pour envoyer une requête POST JSON, utilisez la syntaxe suivante :

const assert = require('assert');
(async function () {
    // Send JSON Data example
    let URL = 'https://reqres.in/api/users';

    // Define JSON data
    let data = {
      'job': 'leader',
      'name': 'morpheus'
    };

    // Make POST request
    let response = await $got.post(URL, {
      header: {
        'content-type': 'application/json'
      },
      json: data
    });

    // Validate the response code, if assertion fails, log "failed to create message, error is " plus 
    // results as error message on Synthetic dashboard
    assert.ok(response && response.statusCode == 201, 'expect 201');
})();
 

Pour envoyer une requête via le formulaire POST, utilisez la syntaxe suivante :

const assert = require('assert');
(async function () {
    const response = await $got.post('https://httpbin.org/anything', {
      form: {
        text: 'hello world'
      }
    });

    assert.ok(response && response.statusCode == 200, 'expect 200');
})();    
 

Pour envoyer une requête « HTTPS » et autoriser un certificat non sécurisé, utilisez la syntaxe suivante :

 // Allow the insecure certificate
 await $got('https://example.com', {
   https:{ rejectUnauthorized: false }
 });
 

Pour envoyer une requête au protocole TLS / SSL avec un certificat, utilisez la syntaxe suivante :

 // Single key with passphrase
 await $got('https://example.com', {
   https: {
     key: $secure.key,
     certificate: $secure.certificate,
     passphrase: $secure.passphrase
   }
 });
 

Pour envoyer une demande d'authentification de base, utilisez la syntaxe suivante:

 await $got.get('http://some.server.com/', {
   https:{ rejectUnauthorized: false },
   headers: {
     Authorization: "Basic " + $secure.AUTH_CRED
   }
 });
 

Pour envoyer une demande d'authentification du support, utilisez la syntaxe suivante :

 await $got.get('http://some.server.com/', {
   headers: {
     'Authorization': "Bearer " + $secure.authToken
   }
 });
 

Pour importer un module pris en charge, suivez la procédure standard relative à l'importation Node.js . Voir l'exemple suivant :

const crypto = require('crypto-js');
 

Les modules principaux pris en charge sont les suivants:

• produire une assertion
• points d'ancrage async
• zone tampon
• constantes
• chiffrement
• dgram
• serveur de noms de domaine
• domaine
• événements
• fs
• http
• http2
• https
• module (module)
• réseau
• système d'exploitation
• chemin d'accès
• points d'ancrage perf_hooks
• Punycode
• queryString
• flux
• décodeur de chaîne
• Temporisateurs
• tls
• événements_trace
• unité tty
• url
• Util
• zlib

Les modules tiers suivants sont pris en charge:

• Assertion-plus 1.0.0
• atob 2.1.2
• @aws-sdk/client-cloudwatch 3.624.0
• @aws-sdk/client-s3 3.626.0
• @aws-sdk/client-secrets-manager 3.624.0
• @aws-sdk/client-sts 3.624.0
• @babel/core 7.23.2
• @ibm-cloud/secrets-manager 2.0.10
• akamai-edgegrid 3.4.5
• 4.6.6 de base sur FTP
• 1.20.0 de Body-Parser
• btoa 1.2.1
• cloner 0.1.19
• couleurs 1.4.0
• consoleplusplus 1.4.4
• crypto-js 4.2.0
• débogage 2.6.9
• extension 3.0.2
• faker 5.5.3
• obtenu 11.8.6
• joi 17.6.0
• js-yaml 3.14.1
• jsprim 1.4.2
• kafkajs 2.2.4
• ldapauth-fork 5.0.5
• lodash 4.17.21
• instant 2.29.4
• 6.5.0 MongoDB
• 11.0.1 de MSSQL
• 3.8.2 de net-snmp
• node-stream-zip 1.15.0
• oracledb 6.9.0
• 14.2.0 client-serveur
• protocol-buffers 4.2.0
• q 1.5.1
• requête (basée sur @cypress/request@3.0.1)
• doit être 13.2.3
• sip 0.0.6
• ssh2-sftp-client 7.2.3
• sshpk 1.17.0
• ssl-checker 2.0.8
• swagger-parser 8.0.4
• telnet-client 2.2.1
• codage de texte 0.7.0
• 0.14.2 de seconde main
• Cookie-difficile 4.1.3
• soulignement 1.13.4
• décompresser 0.10.11
• url-parse 1.5.10
• urllib2.43.0
• uuid 3.4.0
• valideur 13.7.0
• ws7.5.10
• xml2js 0.5.0

Pour tester et déboguer un script d' API, utilisez la script-cli commande indiquée dans l'exemple suivant :

# Usage:
# test a single script
script-cli <script_name>
# test bundled scripts
script-cli -d <dir> <script-entry-file>
# Example:
script-cli examples/example1.js
script-cli -d examples/bundle-example1 index.js
 

Après avoir créé un script synthétique, procédez comme suit:

1. Utilisez synthetic-api-script pour créer un script API, puis convertissez ce script en chaîne de caractères à l'aide de la script-cli commande :

   # Usage:
   script-cli -s <script-file-path>
   # Example:
   script-cli -s examples/got-get.js
    

   L'exemple suivant affiche le résultat:

   {
     "syntheticType":"HTTPScript",
     "script":"var assert = require('assert');\n\n(async function() {\n  var options = {\n    url: 'https://httpbin.org/get',\n    https:{\n      rejectUnauthorized: false\n    }\n  };\n\n  let response = await $got.get(options);\n  assert.equal(response.statusCode, 200, 'Expected a 200 OK response');\n  console.log('Request URL %s, statusCode: %d', response.url, response.statusCode);\n})();\n"
   }
    

2. Copiez-collez le contenu du script pour créer l'exemple suivant : API script test JSON.

   {
     "label": "APIScript_Test",
     "active": true,
     "testFrequency": 1,
     "locations": ["DemoPoP1_saas_instana_test"],
     "configuration": {
       "syntheticType": "HTTPScript",
       "script": "converted script string"
     }
   }
    

Si la logique métier est complexe, ne contez pas tout dans un seul script car il est difficile pour les développeurs de gérer plusieurs fichiers script dans un référentiel Git .

Pour créer un test de script groupé d' API, procédez comme suit :

1. Regroupez les scripts dans un fichier compressé à l'aide de la commande script-cli :

   # Usage:
   script-cli -z <bundle-script-folder> <entry-script>
   # Example:
   script-cli -z bundle-example1 bundle-example1/index.js
    

2. Remplissez les champs scriptFile et bundle de la configuration de test avec la sortie de la script-cli commande :

   • scriptFile est le point d'entrée des scripts intégrés.
   • bundle est le fichier compressé codé avec base64.

Pour créer un test intégré synthétique, remplissez le contenu du test comme illustré dans l'exemple suivant:

 {
   "label": "APIScriptBundle_Test",
   "active": true,
   "testFrequency": 5,
   "locations": ["DemoPoP1_saas_instana_test"],
   "configuration": {
     "syntheticType": "HTTPScript",
     "scripts": {
       "scriptFile": "index.js",
       "bundle": "zipped scripts encoded with base64"
     }
   }
 }
 

Pour créer des données d'identification, vous pouvez utiliser la commande synctl . La création d'un identifiant pour le nom d'utilisateur et d'un identifiant pour le mot de passe est illustrée dans l'exemple suivant :

synctl create cred --key username --value user123

synctl create cred --key password --value pass123
 

L'authentification de base avec les données d'identification est illustrée dans l'exemple suivant:

const assert = require('assert');

(async function(){
    const auth = Buffer.from($secure.username + ":" + $secure.password).toString('base64');

    let gotResponse = await $got.get('https://<your-basic-auth-url>', {
        // If rejectUnauthorized is true, it will throw on invalid certificates, such as expired or self-signed ones.
        https:{ rejectUnauthorized: false },
        // set additional headers
        headers: {
            Authorization: `Basic ${auth}`
        },
        timeout: {
            request: 10000 //ms
        }
      }
    );

    console.log('Response statusCode:', gotResponse.statusCode);

    // verify status code
    assert.ok(gotResponse.statusCode == 200, "GET statusCode is " + gotResponse.statusCode + ", it should be 200");
})();
 

Vous pouvez utiliser le script Instana API pour tester les API httpbin de manière synchronisée, comme suit :

const assert = require('assert');

async function getExample(){
    var getOptions = {
        url: 'https://httpbin.org/get',
        https:{ rejectUnauthorized: false },
        headers: {
            'Additional-Header': 'Additional-Header-Data'
        }
    };

    let getResponse = await $got.get(getOptions);
    console.info("Sample API - GET, response code: " + getResponse.statusCode);
    assert.ok(getResponse.statusCode == 200, "GET status is " + getResponse.statusCode + ", it should be 200");
    var bodyObj1 = JSON.parse(getResponse.body);
    assert.ok(bodyObj1.url == "https://httpbin.org/get", "httpbin.org REST API GET URL verify failed");
}

async function postExample(){
    var postOptions = {
        url: 'https://httpbin.org/post',
        json: {
            "name1": "this is the first data",
            "name2": "second data"
        },
        https:{ rejectUnauthorized: false },
        headers:{"accept": "application/json"}
    };

    let postResponse = await $got.post(postOptions);
    console.info("Sample API - POST, response code: " + postResponse.statusCode);
    assert.ok(postResponse.statusCode == 200, 'POST status is ' + postResponse.statusCode + ', it should be 200');
    const jsonBody2 = JSON.parse(postResponse.body);
    assert.equal(jsonBody2.json.name1, 'this is the first data', 'Expected this is the first data');
    assert.equal(jsonBody2.json.name2, 'second data', 'Expected second data');
}

async function putExample(){
    var putOptions = {
        url: 'https://httpbin.org/put',
        json: {
            "name1": 'this is the first data',
            "name2": 'second data'
        },
        https:{ rejectUnauthorized: false },
        headers:{"accept": "application/json"}
    };

    let putResponse = await $got.put(putOptions);
    console.info("Sample API - PUT, response code: " + putResponse.statusCode);
    assert.ok(putResponse.statusCode == 200, 'PUT status is ' + putResponse.statusCode + ', it should be 200');
    const jsonBody3 = JSON.parse(putResponse.body);
    assert.ok(jsonBody3.url == "https://httpbin.org/put", "httpbin.org REST API PUT URL verify failed");
    assert.equal(jsonBody3.json.name2, 'second data', 'Expected second data');
}

async function deleteExample(){
    var deleteOptions = {
        url: 'https://httpbin.org/delete',
        https:{ rejectUnauthorized: false },
        headers:{"accept": "application/json"}
    };

    let deleteResponse = await $got.delete(deleteOptions);
    console.info("Sample API - DELETE, response code: " + deleteResponse.statusCode);
    assert.ok(deleteResponse.statusCode == 200, 'DELETE status is ' + deleteResponse.statusCode + ', it should be 200');
    const jsonBody4 = JSON.parse(deleteResponse.body);
    assert.ok(jsonBody4.url == "https://httpbin.org/delete", "httpbin.org REST API DELETE URL verify failed");
}

function showEnvironment(){
    // to print environment variables
    console.info('List PoP environment variables using $synthetic API');
    console.info('Test ID:', $synthetic.TEST_ID);
    console.info('Test Name:', $synthetic.TEST_NAME);
    console.info('Location:', $synthetic.LOCATION);
    console.info('TimeZone:', $synthetic.TIME_ZONE);
    console.info('Job ID:', $synthetic.JOB_ID);

    // to print test custom property defined in customProperties of test definition 
    console.info('Test custom property -> Team: ' + $synthetic.labels.Team);
    console.info('Test custom property -> Purpose: ' + $synthetic.labels.Purpose);

    // to set custom tags dynamically
    // Users can use tag key to to pass the customized value to Smart Alert custom payload 
    $attributes.set('tag_key1', 'value1');
}

async function main(){
    await getExample();
    await postExample()
    await putExample();
    await deleteExample();

    await showEnvironment();
}

main();

 

Pour plus d'exemples de scripts d' API, consultez le script « Synthetic API ».