treblle/treblle-net-core

The official Treblle SDK for .NET Core. Seamlessly integrate Treblle to manage communication with your dashboard, send errors, and secure sensitive data.

Treblle

Integrations   •   Website   •   Docs   •   Blog   •   Twitter   •   Discord

---

Treblle is a lightweight SDK that helps Engineering and Product teams build, ship & maintain REST based APIs faster.

Features

• API Monitoring & Observability
• Auto-generated API Docs
• API analytics
• Treblle API Score
• API Lifecycle Collaboration
• Native Treblle Apps

How Treblle Works

Once you’ve integrated a Treblle SDK in your codebase, this SDK will send requests and response data to your Treblle Dashboard.

In your Treblle Dashboard you get to see real-time requests to your API, auto-generated API docs, API analytics like how fast the response was for an endpoint, the load size of the response, etc.

Treblle also uses the requests sent to your Dashboard to calculate your API score which is a quality score that’s calculated based on the performance, quality, and security best practices for your API.

Visit https://docs.treblle.com for the complete documentation.

Security

Masking fields

Masking fields ensure certain sensitive data are removed before being sent to Treblle.

To make sure masking is done before any data leaves your server we built it into all our SDKs.

This means data masking is super fast and happens on a programming level before the API request is sent to Treblle. You can customize exactly which fields are masked when you’re integrating the SDK.

Visit the Masked fields section of the docs for the complete documentation.

Get Started

1. Sign in to Treblle.
2. Create a Treblle project.
3. Setup the SDK for your platform.

Install the SDK

You can install Treblle .NET Core via NuGet Package Manager or by running the following command:

dotnet add package Treblle.Net.Core

Configuring Treblle

You will need to add the required service by calling AddTreblle and providing your API key and Project ID.

Here's an example of configuring the Treblle services and fetching the configuration values from the application settings:

builder.Services.AddTreblle(
    builder.Configuration["Treblle:ApiKey"],
    builder.Configuration["Treblle:ProjectId"]);

Next you'll need to add the TreblleMiddleware by calling UseTreblle on the WebApplication instance. You can optionally configure the use of the exception handler middleware.

app.UseTreblle(useExceptionHandler: true);

Using Treblle with Controllers

Now you can specify which endpoints you want Treblle to track by adding this simple attribute to any API controller or method:

[Treblle]

Using Treblle with Minimal APIs

To tell Treblle to track your Minimal API endpoints, you have to apply UseTreblle to your endpoint definition:

app.MapGet("/", () => "Treblle is awesome")
    .UseTreblle();

That's it. Your API requests and responses are now being sent to your Treblle project.

See the docs for this SDK to learn more.

Masking Additional Fields

If you want to expand the list of fields you want to hide, you can pass property names you want to hide as a CSV string to the AddTreblle call:

builder.Services.AddTreblle(
    builder.Configuration["Treblle:ApiKey"],
    builder.Configuration["Treblle:ProjectId"],
    "secretField,highlySensitiveField");

Running Treblle only in production

If you want to run Treblle only in production, you can rely on the environment variables, or use a similar approach via your application config.

if (app.Environment.IsProduction())
{
    app.UseTreblle();
}

Available SDKs

Treblle provides open-source SDKs that let you seamlessly integrate Treblle with your REST-based APIs.

• treblle-laravel: SDK for Laravel
• treblle-php: SDK for PHP
• treblle-symfony: SDK for Symfony
• treblle-lumen: SDK for Lumen
• treblle-sails: SDK for Sails
• treblle-adonisjs: SDK for AdonisJS
• treblle-fastify: SDK for Fastify
• treblle-directus: SDK for Directus
• treblle-strapi: SDK for Strapi
• treblle-express: SDK for Express
• treblle-koa: SDK for Koa
• treblle-go: SDK for Go
• treblle-ruby: SDK for Ruby on Rails
• treblle-python: SDK for Python/Django

See the docs for more on SDKs and Integrations.

Other Packages

Besides the SDKs, we also provide helpers and configuration used for SDK development. If you're thinking about contributing to or creating a SDK, have a look at the resources below:

• treblle-utils: A set of helpers and utility functions useful for the JavaScript SDKs.
• php-utils: A set of helpers and utility functions useful for the PHP SDKs.

Community 💙

First and foremost: Star and watch this repository to stay up-to-date.

Also, follow our Blog, and on Twitter.

You can chat with the team and other members on Discord and follow our tutorials and other video material at YouTube.

How to contribute

Here are some ways of contributing to making Treblle better:

• Try out Treblle, and let us know ways to make Treblle better for you. Let us know here on Discord.
• Join our Discord and connect with other members to share and learn from.
• Send a pull request to any of our open source repositories on Github. Check the contribution guide on the repo you want to contribute to for more details about how to contribute. We're looking forward to your contribution!

Contributors

treblle-net-core's Issues

Figure out why getting configurations values don't work

Treblle reporting a score of 0 for HTTP2/3 support

Hi There

I noticed that Treblle is reporting a zero score for HTTP2/3 support for my API. My service is configured for HTTP/2 support, and I can see in Chrome Dev Tools that the protocol used is H2 when calling my API.

Digging into the code for the Payload Factory I can see this

    private static void AddServer(HttpContext httpContext, TrebllePayload payload)
    {
        payload.Data.Server.Ip = httpContext.GetServerVariable("LOCAL_ADDR");
        payload.Data.Server.Timezone = (!string.IsNullOrEmpty(TimeZoneInfo.Local.StandardName))
            ? TimeZoneInfo.Local.StandardName
            : "UTC";
        payload.Data.Server.Software = httpContext.GetServerVariable("SERVER_SOFTWARE");
        payload.Data.Server.Signature = null;
        payload.Data.Server.Protocol = httpContext.GetServerVariable("SERVER_PROTOCOL");

        payload.Data.Server.Os.Name = Environment.OSVersion.ToString();
        payload.Data.Server.Os.Release = Environment.OSVersion.Version.ToString();
        payload.Data.Server.Os.Architecture = Environment.GetEnvironmentVariable("PROCESSOR_ARCHITECTURE");
    }

If I change the protocol line to

    private static void AddServer(HttpContext httpContext, TrebllePayload payload)
    {
        payload.Data.Server.Ip = httpContext.GetServerVariable("LOCAL_ADDR");
        payload.Data.Server.Timezone = (!string.IsNullOrEmpty(TimeZoneInfo.Local.StandardName))
            ? TimeZoneInfo.Local.StandardName
            : "UTC";
        payload.Data.Server.Software = httpContext.GetServerVariable("SERVER_SOFTWARE");
        payload.Data.Server.Signature = null;
        payload.Data.Server.Protocol = httpContext.Request.Protocol;

        payload.Data.Server.Os.Name = Environment.OSVersion.ToString();
        payload.Data.Server.Os.Release = Environment.OSVersion.Version.ToString();
        payload.Data.Server.Os.Architecture = Environment.GetEnvironmentVariable("PROCESSOR_ARCHITECTURE");
    }

httpContext.Request.Protocol returns a value of HTTP/2 whereas httpContext.GetServerVariable("SERVER_PROTOCOL") returns a value of HTTP/1.1

I've tried researching why the two methods return different values, but cannot find an answer.

I would be happy to submit a pull-request with this change, but I wondered if you know why the 2 methods differ, and whether we can rely on the httpContext.Request.Protocol property to get the true HTTP protocol version?

Secondary to this, when I have tested locally using httpContext.Request.Protocol and sending Treblle the value HTTP/2, Treblle is still giving my API a score of 0 for HTTP2/3 support. What are the values that treblle will accept? I reviewed the SDKs for the Ruby and .NET integrations, and they are both using the SERVER_PROTOCOL server variable, which would return HTTP/2 I believe when HTTP/2 is being used.

Masking of fields not working as expected for .NET 4.6.1

Masking of fields works as expected for .NET 6 but not for .NET 4.6.1

Add a function to random return the Treblle base URL