Edit

.NET SDK Instrumentation

This page will dive into the nitty gritty details on installing Rookout under various configurations.
If you are encountering any difficulties with deploying Rookout, this is the place to look.

.NET

The .NET SDK provides the ability to fetch debug data from a running application in real time.

It can easily be installed as a NuGet package.

Setup

Start the SDK within your application:

using Rook;
namespace Program
{
    class Program
    {
        static int Main(string[] args)
        {
            Rook.RookOptions options = new Rook.RookOptions() 
            {
                token = "[Your Rookout Token]",
                labels = new Dictionary<string, string> { { "env", "dev" } }
            };
            Rook.API.Start(options);
    
            // ...
        }
    }
}
Imports Rook

Module Program
    Sub Main(args As String())
        Dim opts = New RookOptions()
        opts.token = "[Your Rookout Token]"
        opts.labels = New Dictionary(Of String, String)()
        opts.labels.Add("env", "dev")
        Rook.API.Start(opts)
    
        //......
    
    End Sub
End Module
open System
open Rook
open System.Collections.Generic

[<EntryPoint>]
let main argv =
    let labels = new Dictionary<string, string>()
    labels.Add("env", "dev")
  
    let opt = Rook.RookOptions(token="[Your Rookout Token]", labels=labels)
    Rook.API.Start(opt)

    // .....

Check out the debug information, source information, and packaging-sources sections for recommendations on how to configure the build process.

SDK API

start

public static void Start(RookOptions opts)

The Start method is used to initialize the SDK in the background and accepts a RookOptions object with the following attributes:

Argument                          Environment Variable                              Default ValueDescription
tokenROOKOUT_TOKENNoneThe Rookout token for your organization. Should be left empty if you are using a Rookout ETL Controller
labelsROOKOUT_LABELS{}A dictionary of key:value labels for your application instances. Use k:v,k:v format for environment variables
git_commitROOKOUT_COMMITNoneString that indicates your git commit or a branch name
git_originROOKOUT_REMOTE_ORIGINNoneString that indicates your git remote origin
hostROOKOUT_CONTROLLER_HOSTNoneIf you are using a Rookout ETL Controller, this is the hostname for it
portROOKOUT_CONTROLLER_PORTNoneIf you are using a Rookout ETL Controller, this is the port for it
proxyROOKOUT_PROXYNoneURL to proxy server
debugROOKOUT_DEBUGFalseSet to True to increase log level to debug

Test connectivity

To make sure the SDK was properly installed and test your configuration (environment variables only), download and run TestConnectivity:

Unix:

  • Core 2.x: chmod +x ./rookout_test_core_2.x.sh && ./rookout_test_core_2.x.sh
  • Core 3.x: chmod +x ./rookout_test_core_3.x.sh && ./rookout_test_core_3.x.sh

Windows: Simply run rookout_test_core_2.x.bat or rookout_test_core_3.x.bat respectively.

Debug Information

Rookout requires your application to be built and deployed with a debug information in the form of a pdb file. Rookout supports the full, portable and pdbonly configurations, while embedded is not supported.

For further reading: https://devblogs.microsoft.com/devops/understanding-symbol-files-and-visual-studios-symbol-settings/

Disabling compiler optimizations <Optimize>false</Optimize> will further improve the debugging experience at a small cost to the application performance.

Source information

Use the MSBuildGitHash package to embed the Git remote origin and commit hash to your application binary.

After installing the MSBuildGitHash NuGet package add the following line in the .csproj file:

    <MSBuildGitHashCommand>git config --get remote.origin.url %26%26 git rev-parse HEAD</MSBuildGitHashCommand>

Packaging Sources

To make sure you are collecting data from the source line where you have set the breakpoint, include your source files within your library.

    <EmbedAllSources>true</EmbedAllSources>

Dynamic library loading

To be able to debug libraries loaded using AppDomain.Load(Byte[], Byte[]) make sure to load those binaries into Rookout using:

Rook.API.LoadAssembly(Assembly a, byte[] pdb, byte[] assembly)

Supported Versions

ImplementationVersions
.NET Framework4.5, 4.6, 4.7, 4.8
.NET Core2.1, 2.2, 3.0, 3.1
.NET5.0

Supported Languages

The following languages are officially supported: C#, VB.NET and F#.

IIS support

We currently support IIS 8.0 and above.

If the environment you are trying to debug is not mentioned in the list above, be sure to let us know: support@rookout.com

Serverless and PaaS deployments

Integrating with AWS Lambda

When integrating Rookout into an application running on AWS Lambda, you should explicitly flush the collected information once lambda execution concludes.
Rookout provides an easy to use wrapper - wrap your code with using (Rook.API.StartLambda(options)) as in the example below:

using Rook;

namespace LambdaExample
{
    public class Function
    {

        public string FunctionHandler(string input, ILambdaContext context)
        {
            Rook.RookOptions options = new Rook.RookOptions()
            {
                labels = new Dictionary<string, string> { { "env", "lambda" } }
            };
            using (Rook.API.StartLambda(options))
            {
                /// Your code
                return "Hello World";
            }
        }
    }
}

On .NET Core 3 or newer, you can also use await using instead of just using.

Note: Adding the Rookout SDK will slow down your Serverless cold-start times. Please make sure your timeout is no less than 20 seconds.

Refer to the SDK API for the available optional options

← JVMPython →