Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

V4.1 includes properties to control various aspects of the flow's behavior using an internally-defined bean that may be overridden if required.

Expand
titleBeans

Name

Type

Description

shibboleth.metrics.MetricRegistry

FilteredMetricRegistry

Registry of all metrics known to the system

shibboleth.metrics.RegisterMetricSets

MethodInvokingBean

Spring parent bean for invoking the registerMultiple method on the registry

shibboleth.metrics.RegisterMetricSet

MethodInvokingBean   

Spring parent bean for invoking the register method on the registry

shibboleth.metrics.CoreGaugeSet

MetricSet / MetricFilter

Low-level gauges for OS, Java, and memory information

shibboleth.metrics.IdPGaugeSet

MetricSet / MetricFilter

Basic IdP system information (version, uptime)

shibboleth.metrics.LoggingGaugeSet

MetricSet / MetricFilter

Information about the logging service

shibboleth.metrics.AccessControlGaugeSet

MetricSet / MetricFilter

Information about the access control service

shibboleth.metrics.MetadataGaugeSet

MetricSet / MetricFilter

Information about the metadata resolver service

shibboleth.metrics.RelyingPartyGaugeSet

MetricSet / MetricFilter

Information about the RelyingParty configuration service

shibboleth.metrics.NameIdentifierGaugeSet

MetricSet / MetricFilter

Information about the Name Identifier generation service

shibboleth.metrics.AttributeResolverGaugeSet     

MetricSet / MetricFilter

Information about the attribute resolver service

shibboleth.metrics.AttributeFilterGaugeSet

MetricSet / MetricFilter

Information about the attribute filter service

shibboleth.metrics.AttributeRegistryGaugeSet 4.1

MetricSet / MetricFilter

Information about the attribute registry service

shibboleth.metrics.HTTPReporter

HTTPReporter

A schedulable background reporter that sends a JSON feed of metrics to a URL

shibboleth.metrics.MetricGroups

Map<String,MetricFilter>

Associates metrics matching a supplied filter with a string label that "names" that set of metrics

shibboleth.metrics.MetricLevelMap

Map<String,Level>

Optional mapping of metric names to logging levels to associate with the metric

shibboleth.metrics.DefaultAccessPolicy

String

Name of the access control policy to apply to the metrics API in the absence of a more specific policy

shibboleth.metrics.AccessPolicyMap

Map<String,String>

Maps a named metric group/filter from the "shibboleth.metrics.MetricGroups" bean to a named access control policy to apply when accessing that group via the API

shibboleth.metrics.AccessPolicyStrategy

Function<ProfileRequestContext,String>

A mechanism to determine the access control policy to apply to a request to the metrics API, normally relies on the two previous beans but can be replaced if desired

shibboleth.metrics.AllowedOrigin

String

Optional "Access-Control-Allow-Origin" header value to return within REST API response

shibboleth.metrics.JSONPCallback

String

Optional name of JSONP callback function to pass the REST API response

shibboleth.metrics.MetricStrategy

Function<ProfileRequestContext,Boolean>

A hook to provide a function to execute at the beginning of every request that can programmatically enable timers and counters for objects during the execution of that request

shibboleth.metrics.ExposedProperties 4.1

Set<String>

Collection of property names to expose as IdP metric gauges. Take care not to expose confidental information through this hook.

Expand
titleProperties (V4.1+)

The general properties configuring this flow via admin/admin.properties are:

Name

Default

Description

idp.metrics.logging

Metrics

Audit log identifier for flow

idp.metrics.authenticated

false

Whether authentication should be performed prior to access control evaluation

idp.metrics.nonBrowserSupported

false

Whether the flow should allow for non-browser clients during authentication

idp.metrics.resolveAttributes

false

Whether attributes should be resolved prior to access control evaluation

...