Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[docs-metrics] Remove predicate-based View examples #5554

Merged
merged 2 commits into from
Apr 19, 2024
Merged

[docs-metrics] Remove predicate-based View examples #5554

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c1214c4
Remove predicate based View examples
reyang Apr 19, 2024
b27340e
rewording
reyang Apr 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 0 additions & 12 deletions docs/metrics/customizing-the-sdk/Program.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,18 +40,6 @@ public static void Main()
// Drop the instrument "MyCounterDrop".
.AddView(instrumentName: "MyCounterDrop", MetricStreamConfiguration.Drop)

// Advanced selection criteria and config via Func<Instrument, MetricStreamConfiguration>
.AddView((instrument) =>
{
if (instrument.Meter.Name.Equals("CompanyA.ProductB.Library2") &&
instrument.GetType().Name.Contains("Histogram"))
{
return new ExplicitBucketHistogramConfiguration() { Boundaries = new double[] { 10, 20 } };
}

return null;
})

// An instrument which does not match any views
// gets processed with default behavior. (SDK default)
// Uncommenting the following line will
Expand Down
84 changes: 3 additions & 81 deletions docs/metrics/customizing-the-sdk/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,14 +115,9 @@ name starts with "Abc.".
A
[View](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/metrics/sdk.md#view)
provides the ability to customize the metrics that are output by the SDK.
Following sections explains how to use this feature. Each section has two code
snippets. The first one uses an overload of `AddView` method that takes in the
name of the instrument as the first parameter. The `View` configuration is then
applied to the matching instrument name. The second code snippet shows how to
use an advanced selection criteria to achieve the same results. This requires
the user to provide a `Func<Instrument, MetricStreamConfiguration>` which offers
more flexibility in filtering the instruments to which the `View` should be
applied.
Following sections explains how to use `AddView` method that takes the
instrument name as the first parameter, the `View` configuration is then applied
to the matching instrument name.

#### Rename an instrument

Expand All @@ -136,20 +131,6 @@ own the instrument to create it with a different name.
.AddView(instrumentName: "MyCounter", name: "MyCounterRenamed")
reyang marked this conversation as resolved.
Show resolved Hide resolved
```

```csharp
// Advanced selection criteria and config via Func<Instrument, MetricStreamConfiguration>
.AddView((instrument) =>
{
if (instrument.Meter.Name == "CompanyA.ProductB.LibraryC" &&
instrument.Name == "MyCounter")
{
return new MetricStreamConfiguration() { Name = "MyCounterRenamed" };
}

return null;
})
```

#### Drop an instrument

When using `AddMeter` to add a Meter to the provider, all the instruments from
Expand All @@ -162,20 +143,6 @@ then it is recommended to simply not add that `Meter` using `AddMeter`.
.AddView(instrumentName: "MyCounterDrop", MetricStreamConfiguration.Drop)
```

```csharp
// Advanced selection criteria and config via Func<Instrument, MetricStreamConfiguration>
.AddView((instrument) =>
{
if (instrument.Meter.Name == "CompanyA.ProductB.LibraryC" &&
instrument.Name == "MyCounterDrop")
{
return MetricStreamConfiguration.Drop;
}

return null;
})
```

#### Select specific tags

When recording a measurement from an instrument, all the tags that were provided
Expand Down Expand Up @@ -219,23 +186,6 @@ with the metric are of interest to you.
...
```

```csharp
// Advanced selection criteria and config via Func<Instrument, MetricStreamConfiguration>
.AddView((instrument) =>
{
if (instrument.Meter.Name == "CompanyA.ProductB.LibraryC" &&
instrument.Name == "MyFruitCounter")
{
return new MetricStreamConfiguration
{
TagKeys = new string[] { "name" },
};
}

return null;
})
```

#### Configuring the aggregation of a Histogram

There are two types of
Expand Down Expand Up @@ -274,24 +224,6 @@ default boundaries. This requires the use of
new ExplicitBucketHistogramConfiguration { Boundaries = Array.Empty<double>() })
```

```csharp
// Advanced selection criteria and config via Func<Instrument, MetricStreamConfiguration>
.AddView((instrument) =>
{
if (instrument.Meter.Name == "CompanyA.ProductB.LibraryC" &&
instrument.Name == "MyHistogram")
{
// `ExplicitBucketHistogramConfiguration` is a child class of `MetricStreamConfiguration`
return new ExplicitBucketHistogramConfiguration
{
Boundaries = new double[] { 10, 20 },
};
}

return null;
})
```

##### Base2 exponential bucket histogram aggregation

By default, a Histogram is configured to use the
Expand All @@ -313,16 +245,6 @@ within the maximum number of buckets defined by `MaxSize`. The default
new Base2ExponentialBucketHistogramConfiguration { MaxSize = 40 })
```

```csharp
// Configure all histogram instruments to use the Base2 Exponential Histogram aggregation
.AddView((instrument) =>
{
return instrument.GetType().GetGenericTypeDefinition() == typeof(Histogram<>)
? new Base2ExponentialBucketHistogramConfiguration()
: null;
})
```

> [!NOTE]
> The SDK currently does not support any changes to `Aggregation` type
by using Views.
Expand Down