{"componentChunkName":"component---src-components-mark-down-block-js","path":"/docs/library-using/","result":{"data":{"markdownRemark":{"html":"

Using the Library (libscope.so)

\n

To use the library for the first time in a given environment, complete this quick procedure:

\n
    \n
  1. Download AppScope.
    2. \n
  2. Decide on a SCOPE_HOME directory, i.e., the directory from which AppScope should run in your environment.
    3. \n
  3. \n

    Set SCOPE_HOME to the desired directory.

    \n
    ubuntu@my_hostname:~/someuser/temp$ export SCOPE_HOME=/opt/appscope\n
    \n
    4. \n
  4. \n

    Create the SCOPE_HOME directory. (Here, sudo is required because opt is owned by root.)

    \n
    ubuntu@my_hostname:~/someuser/temp$ sudo mkdir $SCOPE_HOME\n
    \n
    5. \n
  5. \n

    Extract (scope extract) the contents of the AppScope binary into the SCOPE_HOME directory.

    \n
    ubuntu@my_hostname:~/someuser/temp$ sudo ./scope extract $SCOPE_HOME\nSuccessfully extracted to /opt/appscope.\n
    \n
    6. \n
  6. \n

    Verify that SCOPE_HOME contains the AppScope library (libscope.so) and the config file (scope.yml).

    \n
    ubuntu@my_hostname:~/someuser/temp$ ls -al $SCOPE_HOME\ntotal 20528\ndrwxr-xr-x 2 root root     4096 Jul 11 22:51 .\ndrwxr-xr-x 5 root root     4096 Jul 11 22:51 ..\n-rwxr-xr-x 1 root root  9663240 Jul 11 22:51 libscope.so\n-rw-r--r-- 1 root root    35755 Jul 11 22:51 scope.yml\nubuntu@my_hostname:~/someuser/temp$ \n
    \n
    7. \n
\n

Now you are ready to configure AppScope to instrument any application and output data to any existing tool via simple TCP protocols.

\n

Depending on your use case and preferred way of working, this usually entails editing scope.yml, and then setting environment variables while invoking the library.

\n

How the library is loaded depends on the type of executable. A dynamic loader can preload the library (where supported), while AppScope can load static executables. Regardless of how the library is loaded, you get full control of the data source, formats, and transports.

\n

\n

The Config File

\n

For the default settings in the sample scope.yml configuration file, see Config File, or inspect the most-recent file on GitHub.

\n

To see the config file with comments omitted, run the following command:

\n
egrep -v '^ *#.*$' scope.yml | sed '/^$/d' >scope-minimal.yml\n
\n

This can help you get a clear idea of exactly how AppScope is configured, assuming you have previously read and understood the comments.

\n

Using the Library Directly

\n

To use the library directly, you rely on the LD_PRELOAD environment variable.

\n

The following examples provide an overview of this way of working with the library. All the examples call the system-level ps command, just to show how the syntax works.

\n

For more, check out the Further Examples, which include both CLI and library use cases.

\n

LD_PRELOAD with a Single Command

\n

Start with this basic example:

\n
LD_PRELOAD=./libscope.so ps -ef\n
\n

This executes the command ps -ef. But first, the OS's loader loads the AppScope library, as part of loading and linking the ps executable.

\n

Details of the ps application's execution are emitted to the configured transport, in the configured format. For configuration details, see Env Vars and the Config File above.

\n

LD_PRELOAD with Verbosity Specified

\n
LD_PRELOAD=./libscope.so SCOPE_METRIC_VERBOSITY=5 ps -ef\n
\n

This again executes the ps command using the AppScope library. But it also defines the verbosity for metric extraction as level 5. (This verbosity setting overrides any config-file setting, as well as the default value.)

\n

LD_PRELOAD with a Config File

\n
LD_PRELOAD=./libscope.so SCOPE_HOME=/etc/scope ps -ef\n
\n

This again executes the ps command using the AppScope library. But it also directs the library to use the config file /etc/scope/scope.yml.

\n

LD_PRELOAD with a TCP Connection

\n
LD_PRELOAD=./libscope.so SCOPE_EVENT_DEST=tcp://localhost:9999 SCOPE_CRIBL_ENABLE=false ps -ef\n
\n

This again executes the ps command using the AppScope library. But here, we also specify that events (as opposed to metrics) will be sent over a TCP connection to localhost, using port 9999. (This event destination setting overrides any config-file setting, as well as the default value.)

\n

Adding AppScope to a systemd (boot-time) Service

\n

In this example, we'll add AppScope to the httpd service, described by an httpd.service file which contains an EnvironmentFile=/etc/sysconfig/httpd entry.

\n
    \n
  1. Extract the library to a new directory (/opt/appscope in this example):
    2. \n
\n
mkdir /opt/appscope && cd /opt/appscope\ncurl -Lo scope https://cdn.cribl.io/dl/scope/\\\n $(curl -L https://cdn.cribl.io/dl/scope/latest)/linux/scope && \\\n chmod 755 ./scope\n./scope extract .\n
\n

The result will be that the system uses /opt/appscope/scope.yml to configure libscope.so.

\n
    \n
  1. Add an LD_PRELOAD environment variable to the systemd config file.
    2. \n
\n

In the httpd.service file, edit the /etc/sysconfig/httpd entry to include the following environment variables:

\n
SCOPE_HOME=/opt/appscope\nLD_PRELOAD=/opt/appscope/libscope.so\n
\n

\n

Deploying the Library in an AWS Lambda Function

\n

You can interpose the libscope.so library into an AWS Lambda function as a Lambda layer. By default, Lambda functions use lib as their LD_LIBRARY_PATH, which makes loading AppScope easy.

\n

Assuming that you have created one or more AWS Lambda functions, all you need to do is add the Lambda layer, then set environment variables for the Lambda function.

\n

Adding an AppScope AWS Lambda Layer

\n
    \n
  1. \n

    Start with one of the AWS Lambda Layers for AppScope that Cribl provides. You can obtain the AWS Lambda Layers and their MD5 checksums from the Cribl CDN.

    \n\n
    2. \n
  2. Complete the procedure for creating a layer described in the AWS docs, uploading your AppScope AWS Lambda Layer ZIP file in the upload your layer code step, and choosing x86_64 or ARM64, as appropriate, for Compatible architectures.
    3. \n
  3. After you click Create, note the Version ARN shown for your newly-created layer.
    4. \n
  4. Navigate to Lambda > Layers > Add layer, and in the Choose a layer section, select Specify an ARN.
    5. \n
  5. Enter your layer's ARN, click Verify, and then click Add.
    6. \n
\n

Setting the Lambda Function's Environment Variables

\n

The AWS docs explain how to set environmental variables for Lambda functions. You'll need to enter the following AppScope environment variable settings in the AWS UI.

\n
    \n
  1. \n

    LD_PRELOAD gets your Lambda function working with AppScope.

    \n\n
    2. \n
  2. \n

    SCOPE_EXEC_PATH is required for static executables (like the Go runtime).

    \n\n
    3. \n
  3. \n

    To tell AppScope where to deliver events, the required environment variable depends on your desired Data Routing.

    \n\n
    4. \n
  4. \n

    Optionally, set additional environment variables as desired.

    \n\n
    5. \n
","frontmatter":{"title":"Using the Library"}}},"pageContext":{"slug":"/library-using/","id":"57133b2b-5ede-5e15-817c-1466475dedb7"}},"staticQueryHashes":["2787008656","306729481","625673991","640077088"]}