Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/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.
https://github.com/treblle/treblle-net-core
api api-observability backend developer-tool dotnet-core logging net-core net-core-sdk rest-api restful-api sdk treblle treblle-sdk
Last synced: about 2 months ago
JSON representation
The official Treblle SDK for .NET Core. Seamlessly integrate Treblle to manage communication with your dashboard, send errors, and secure sensitive data.
- Host: GitHub
- URL: https://github.com/treblle/treblle-net-core
- Owner: Treblle
- Created: 2021-08-12T15:04:34.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-03-13T14:11:44.000Z (11 months ago)
- Last Synced: 2024-04-26T18:02:41.711Z (9 months ago)
- Topics: api, api-observability, backend, developer-tool, dotnet-core, logging, net-core, net-core-sdk, rest-api, restful-api, sdk, treblle, treblle-sdk
- Language: C#
- Homepage: https://www.treblle.com/
- Size: 72.3 KB
- Stars: 13
- Watchers: 4
- Forks: 4
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Treblle is a lightweight SDK that helps Engineering and Product teams build, ship & maintain REST based APIs faster.
## Features
- [API Monitoring & Observability](https://www.treblle.com/features/api-monitoring-observability)
- [Auto-generated API Docs](https://www.treblle.com/features/auto-generated-api-docs)
- [API analytics](https://www.treblle.com/features/api-analytics)
- [Treblle API Score](https://www.treblle.com/features/api-quality-score)
- [API Lifecycle Collaboration](https://www.treblle.com/features/api-lifecycle)
- [Native Treblle Apps](https://www.treblle.com/features/native-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](http://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](https://docs.treblle.com/en/security/masked-fields#fields-masked-by-default).
This means data masking is super fast and happens on a programming level before the API request is sent to Treblle. You can [customize](https://docs.treblle.com/en/security/masked-fields#custom-masked-fields) exactly which fields are masked when you’re integrating the SDK.
> Visit the [Masked fields](https://docs.treblle.com/en/security/masked-fields) section of the [docs](https://docs.sailscasts.com) for the complete documentation.
## Get Started
1. Sign in to [Treblle](https://app.treblle.com).
2. [Create a Treblle project](https://docs.treblle.com/en/dashboard/projects#creating-a-project).
3. [Setup the SDK](#install-the-SDK) for your platform.
### Install the SDK
You can install Treblle .NET Core via NuGet Package Manager or by running the following command:
```bash
dotnet add package Treblle.Net.Core
```
### Configuring Treblle
You will need to add the required service by calling `AddTreblle` and providing your [API key](https://docs.treblle.com/en/dashboard#accessing-your-api-key) and [Project ID](https://docs.treblle.com/en/dashboard/projects#project-id).
Here's an example of configuring the Treblle services and fetching the configuration values from the application settings:
```csharp
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.
```csharp
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:
```csharp
[Treblle]
```
**Using Treblle with Minimal APIs**
To tell Treblle to track your Minimal API endpoints, you have to apply `UseTreblle` to your endpoint definition:
```csharp
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](https://docs.treblle.com/en/integrations/net-core) 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:
```csharp
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.
```csharp
if (app.Environment.IsProduction())
{
app.UseTreblle();
}
```
## Available SDKs
Treblle provides [open-source SDKs](https://docs.treblle.com/en/integrations) that let you seamlessly integrate Treblle with your REST-based APIs.
- [`treblle-laravel`](https://github.com/Treblle/treblle-laravel): SDK for Laravel
- [`treblle-php`](https://github.com/Treblle/treblle-php): SDK for PHP
- [`treblle-symfony`](https://github.com/Treblle/treblle-symfony): SDK for Symfony
- [`treblle-lumen`](https://github.com/Treblle/treblle-lumen): SDK for Lumen
- [`treblle-sails`](https://github.com/Treblle/treblle-sails): SDK for Sails
- [`treblle-adonisjs`](https://github.com/Treblle/treblle-adonisjs): SDK for AdonisJS
- [`treblle-fastify`](https://github.com/Treblle/treblle-fastify): SDK for Fastify
- [`treblle-directus`](https://github.com/Treblle/treblle-directus): SDK for Directus
- [`treblle-strapi`](https://github.com/Treblle/treblle-strapi): SDK for Strapi
- [`treblle-express`](https://github.com/Treblle/treblle-express): SDK for Express
- [`treblle-koa`](https://github.com/Treblle/treblle-koa): SDK for Koa
- [`treblle-go`](https://github.com/Treblle/treblle-go): SDK for Go
- [`treblle-ruby`](https://github.com/Treblle/treblle-ruby): SDK for Ruby on Rails
- [`treblle-python`](https://github.com/Treblle/treblle-python): SDK for Python/Django
> See the [docs](https://docs.treblle.com/en/integrations) 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`](https://github.com/Treblle/treblle-utils): A set of helpers and
utility functions useful for the JavaScript SDKs.
- [`php-utils`](https://github.com/Treblle/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](https://blog.treblle.com), and on [Twitter](https://twitter.com/treblleapi).
You can chat with the team and other members on [Discord](https://treblle.com/chat) and follow our tutorials and other video material at [YouTube](https://youtube.com/@treblle).
[](https://treblle.com/chat)
[](https://youtube.com/@treblle)
[](https://twitter.com/treblleapi)
### How to contribute
Here are some ways of contributing to making Treblle better:
- **[Try out Treblle](https://docs.treblle.com/en/introduction#getting-started)**, and let us know ways to make Treblle better for you. Let us know here on [Discord](https://treblle.com/chat).
- Join our [Discord](https://treblle.com/chat) and connect with other members to share and learn from.
- Send a pull request to any of our [open source repositories](https://github.com/Treblle) 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
