public SessionMetrics(IDriverMetricsProvider driverMetricsProvider, DriverMetricsOptions metricsOptions, bool metricsEnabled, string context)
{
_driverMetricsProvider = driverMetricsProvider;
_context = context;
MetricsRegistry = new InternalMetricsRegistry <SessionMetric>(
driverMetricsProvider, SessionMetric.AllSessionMetrics.Except(metricsOptions.EnabledSessionMetrics), metricsEnabled);
}
public NodeMetrics(
IDriverMetricsProvider driverMetricsProvider, DriverMetricsOptions metricOptions, bool metricsEnabled, string bucketName)
{
_driverMetricsProvider = driverMetricsProvider;
_bucketName = bucketName;
MetricsRegistry = new InternalMetricsRegistry <NodeMetric>(
driverMetricsProvider, NodeMetric.AllNodeMetrics.Except(metricOptions.EnabledNodeMetrics), metricsEnabled);
InitializeMetrics();
}
public MetricsManager(IDriverMetricsProvider driverMetricsProvider, DriverMetricsOptions metricsOptions, bool metricsEnabled, string sessionName)
{
_driverMetricsProvider = driverMetricsProvider;
_metricsOptions = metricsOptions;
_metricsEnabled = metricsEnabled;
_sessionBucket = metricsOptions.BucketPrefix != null ? $"{metricsOptions.BucketPrefix}.{sessionName}" : sessionName;
_sessionMetrics = new SessionMetrics(_driverMetricsProvider, metricsOptions, metricsEnabled, _sessionBucket);
_nodeMetricsRegistryCollection = new CopyOnWriteDictionary <Host, IMetricsRegistry <NodeMetric> >();
_nodeMetricsCollection = new CopyOnWriteDictionary <Host, INodeMetrics>();
_disabledSessionTimerMetrics = !metricsEnabled || !metricsOptions.EnabledSessionMetrics.Contains(SessionMetric.Timers.CqlRequests);
_disabledNodeTimerMetrics = !metricsEnabled || !metricsOptions.EnabledNodeMetrics.Contains(NodeMetric.Timers.CqlMessages);
}
/// <summary>
/// <para>
/// Enables metrics. DataStax provides an implementation based on a third party library (App.Metrics)
/// on a separate NuGet package: CassandraCSharpDriver.AppMetrics
/// Alternatively, you can implement your own provider that implements <see cref="IDriverMetricsProvider"/>.
/// </para>
/// <para>
/// This method enables all individual metrics without a bucket prefix. To customize these settings,
/// use <see cref="WithMetrics(IDriverMetricsProvider, DriverMetricsOptions)"/>. For explanations on these settings,
/// see the API docs of the <see cref="DriverMetricsOptions"/> class.
/// </para>
/// <para>
/// The AppMetrics provider also has some settings that can be customized, check out the API docs of
/// Cassandra.AppMetrics.DriverAppMetricsOptions.
/// <para>
/// Here is an example:
/// <code>
/// var cluster =
/// Cluster.Builder()
/// .WithMetrics(
/// metrics.CreateDriverMetricsProvider(new DriverAppMetricsOptions()),
/// new DriverMetricsOptions()
/// .SetEnabledNodeMetrics(NodeMetric.DefaultNodeMetrics.Except(new [] { NodeMetric.Meters.BytesSent }))
/// .SetEnabledSessionMetrics(
/// SessionMetric.DefaultSessionMetrics.Except(new[] { SessionMetric.Meters.BytesReceived }))
/// .SetBucketPrefix("web.app"))
/// .Build();
/// </code>
/// </para>
/// </para>
/// </summary>
/// <param name="driverMetricsProvider">Metrics Provider implementation.</param>
/// <param name="metricsOptions">Metrics Provider implementation.</param>
/// <returns>This builder</returns>
public Builder WithMetrics(IDriverMetricsProvider driverMetricsProvider, DriverMetricsOptions metricsOptions)
{
_driverMetricsProvider = driverMetricsProvider ?? throw new ArgumentNullException(nameof(driverMetricsProvider));
_metricsOptions = metricsOptions?.Clone() ?? throw new ArgumentNullException(nameof(metricsOptions));
return(this);
}
/// <summary>
/// <para>
/// Enables metrics. DataStax provides an implementation based on a third party library (App.Metrics)
/// on a separate NuGet package: CassandraCSharpDriver.AppMetrics
/// Alternatively, you can implement your own provider that implements <see cref="IDriverMetricsProvider"/>.
/// </para>
/// <para>
/// This method enables all individual metrics without a bucket prefix. To customize these options,
/// use <see cref="WithMetrics(IDriverMetricsProvider, DriverMetricsOptions)"/>.
/// </para>
/// </summary>
/// <param name="driverMetricsProvider">Metrics Provider implementation.</param>
/// <returns>This builder</returns>
public Builder WithMetrics(IDriverMetricsProvider driverMetricsProvider)
{
_driverMetricsProvider = driverMetricsProvider ?? throw new ArgumentNullException(nameof(driverMetricsProvider));
_metricsOptions = null;
return(this);
}
/// <summary>
/// Creates a new instance. This class is also used to shareable a context across all instance that are created below one Cluster instance.
/// One configuration instance per Cluster instance.
/// </summary>
internal Configuration(Policies policies,
ProtocolOptions protocolOptions,
PoolingOptions poolingOptions,
SocketOptions socketOptions,
ClientOptions clientOptions,
IAuthProvider authProvider,
IAuthInfoProvider authInfoProvider,
QueryOptions queryOptions,
IAddressTranslator addressTranslator,
IStartupOptionsFactory startupOptionsFactory,
ISessionFactoryBuilder <IInternalCluster, IInternalSession> sessionFactoryBuilder,
IReadOnlyDictionary <string, IExecutionProfile> executionProfiles,
IRequestOptionsMapper requestOptionsMapper,
MetadataSyncOptions metadataSyncOptions,
IEndPointResolver endPointResolver,
IDriverMetricsProvider driverMetricsProvider,
DriverMetricsOptions metricsOptions,
string sessionName,
IRequestHandlerFactory requestHandlerFactory = null,
IHostConnectionPoolFactory hostConnectionPoolFactory = null,
IRequestExecutionFactory requestExecutionFactory = null,
IConnectionFactory connectionFactory = null,
IControlConnectionFactory controlConnectionFactory = null,
IPrepareHandlerFactory prepareHandlerFactory = null,
ITimerFactory timerFactory = null,
IObserverFactoryBuilder observerFactoryBuilder = null)
{
AddressTranslator = addressTranslator ?? throw new ArgumentNullException(nameof(addressTranslator));
QueryOptions = queryOptions ?? throw new ArgumentNullException(nameof(queryOptions));
Policies = policies;
ProtocolOptions = protocolOptions;
PoolingOptions = poolingOptions;
SocketOptions = socketOptions;
ClientOptions = clientOptions;
AuthProvider = authProvider;
AuthInfoProvider = authInfoProvider;
StartupOptionsFactory = startupOptionsFactory;
SessionFactoryBuilder = sessionFactoryBuilder;
RequestOptionsMapper = requestOptionsMapper;
MetadataSyncOptions = metadataSyncOptions?.Clone() ?? new MetadataSyncOptions();
DnsResolver = new DnsResolver();
EndPointResolver = endPointResolver ?? new EndPointResolver(DnsResolver, protocolOptions);
MetricsOptions = metricsOptions ?? new DriverMetricsOptions();
MetricsProvider = driverMetricsProvider ?? new NullDriverMetricsProvider();
SessionName = sessionName;
MetricsEnabled = driverMetricsProvider != null;
ObserverFactoryBuilder = observerFactoryBuilder ?? (MetricsEnabled ? (IObserverFactoryBuilder) new MetricsObserverFactoryBuilder() : new NullObserverFactoryBuilder());
RequestHandlerFactory = requestHandlerFactory ?? new RequestHandlerFactory();
HostConnectionPoolFactory = hostConnectionPoolFactory ?? new HostConnectionPoolFactory();
RequestExecutionFactory = requestExecutionFactory ?? new RequestExecutionFactory();
ConnectionFactory = connectionFactory ?? new ConnectionFactory();
ControlConnectionFactory = controlConnectionFactory ?? new ControlConnectionFactory();
PrepareHandlerFactory = prepareHandlerFactory ?? new PrepareHandlerFactory();
TimerFactory = timerFactory ?? new TaskBasedTimerFactory();
RequestOptions = RequestOptionsMapper.BuildRequestOptionsDictionary(executionProfiles, policies, socketOptions, clientOptions, queryOptions);
ExecutionProfiles = BuildExecutionProfilesDictionary(executionProfiles, RequestOptions);
// Create the buffer pool with 16KB for small buffers and 256Kb for large buffers.
// The pool does not eagerly reserve the buffers, so it doesn't take unnecessary memory
// to create the instance.
BufferPool = new RecyclableMemoryStreamManager(16 * 1024, 256 * 1024, ProtocolOptions.MaximumFrameLength);
Timer = new HashedWheelTimer();
}
/// <summary>
/// Creates a new instance. This class is also used to shareable a context across all instance that are created below one Cluster instance.
/// One configuration instance per Cluster instance.
/// </summary>
internal Configuration(Policies policies,
ProtocolOptions protocolOptions,
PoolingOptions poolingOptions,
SocketOptions socketOptions,
ClientOptions clientOptions,
IAuthProvider authProvider,
IAuthInfoProvider authInfoProvider,
QueryOptions queryOptions,
IAddressTranslator addressTranslator,
IReadOnlyDictionary <string, IExecutionProfile> executionProfiles,
MetadataSyncOptions metadataSyncOptions,
IEndPointResolver endPointResolver,
IDriverMetricsProvider driverMetricsProvider,
DriverMetricsOptions metricsOptions,
string sessionName,
GraphOptions graphOptions,
Guid?clusterId,
string appVersion,
string appName,
MonitorReportingOptions monitorReportingOptions,
TypeSerializerDefinitions typeSerializerDefinitions,
bool?keepContactPointsUnresolved,
ISessionFactory sessionFactory = null,
IRequestOptionsMapper requestOptionsMapper = null,
IStartupOptionsFactory startupOptionsFactory = null,
IInsightsSupportVerifier insightsSupportVerifier = null,
IRequestHandlerFactory requestHandlerFactory = null,
IHostConnectionPoolFactory hostConnectionPoolFactory = null,
IRequestExecutionFactory requestExecutionFactory = null,
IConnectionFactory connectionFactory = null,
IControlConnectionFactory controlConnectionFactory = null,
IPrepareHandlerFactory prepareHandlerFactory = null,
ITimerFactory timerFactory = null,
IObserverFactoryBuilder observerFactoryBuilder = null,
IInsightsClientFactory insightsClientFactory = null,
IContactPointParser contactPointParser = null,
IServerNameResolver serverNameResolver = null,
IDnsResolver dnsResolver = null)
{
AddressTranslator = addressTranslator ?? throw new ArgumentNullException(nameof(addressTranslator));
QueryOptions = queryOptions ?? throw new ArgumentNullException(nameof(queryOptions));
GraphOptions = graphOptions ?? new GraphOptions();
ClusterId = clusterId ?? Guid.NewGuid();
ApplicationVersion = appVersion ?? Configuration.DefaultApplicationVersion;
ApplicationName = appName ?? Configuration.FallbackApplicationName;
ApplicationNameWasGenerated = appName == null;
Policies = policies;
ProtocolOptions = protocolOptions;
PoolingOptions = poolingOptions;
SocketOptions = socketOptions;
ClientOptions = clientOptions;
AuthProvider = authProvider;
AuthInfoProvider = authInfoProvider;
StartupOptionsFactory = startupOptionsFactory ?? new StartupOptionsFactory(ClusterId, ApplicationVersion, ApplicationName);
SessionFactory = sessionFactory ?? new SessionFactory();
RequestOptionsMapper = requestOptionsMapper ?? new RequestOptionsMapper();
MetadataSyncOptions = metadataSyncOptions?.Clone() ?? new MetadataSyncOptions();
DnsResolver = dnsResolver ?? new DnsResolver();
MetricsOptions = metricsOptions ?? new DriverMetricsOptions();
MetricsProvider = driverMetricsProvider ?? new NullDriverMetricsProvider();
SessionName = sessionName;
MetricsEnabled = driverMetricsProvider != null;
TypeSerializers = typeSerializerDefinitions?.Definitions;
KeepContactPointsUnresolved = keepContactPointsUnresolved ?? false;
ObserverFactoryBuilder = observerFactoryBuilder ?? (MetricsEnabled ? (IObserverFactoryBuilder) new MetricsObserverFactoryBuilder() : new NullObserverFactoryBuilder());
RequestHandlerFactory = requestHandlerFactory ?? new RequestHandlerFactory();
HostConnectionPoolFactory = hostConnectionPoolFactory ?? new HostConnectionPoolFactory();
RequestExecutionFactory = requestExecutionFactory ?? new RequestExecutionFactory();
ConnectionFactory = connectionFactory ?? new ConnectionFactory();
ControlConnectionFactory = controlConnectionFactory ?? new ControlConnectionFactory();
PrepareHandlerFactory = prepareHandlerFactory ?? new PrepareHandlerFactory();
TimerFactory = timerFactory ?? new TaskBasedTimerFactory();
RequestOptions = RequestOptionsMapper.BuildRequestOptionsDictionary(executionProfiles, policies, socketOptions, clientOptions, queryOptions, GraphOptions);
ExecutionProfiles = BuildExecutionProfilesDictionary(executionProfiles, RequestOptions);
MonitorReportingOptions = monitorReportingOptions ?? new MonitorReportingOptions();
InsightsSupportVerifier = insightsSupportVerifier ?? Configuration.DefaultInsightsSupportVerifier;
InsightsClientFactory = insightsClientFactory ?? Configuration.DefaultInsightsClientFactory;
ServerNameResolver = serverNameResolver ?? new ServerNameResolver(ProtocolOptions);
EndPointResolver = endPointResolver ?? new EndPointResolver(ServerNameResolver);
ContactPointParser = contactPointParser ?? new ContactPointParser(DnsResolver, ProtocolOptions, ServerNameResolver, KeepContactPointsUnresolved);
// Create the buffer pool with 16KB for small buffers and 256Kb for large buffers.
// The pool does not eagerly reserve the buffers, so it doesn't take unnecessary memory
// to create the instance.
BufferPool = new RecyclableMemoryStreamManager(16 * 1024, 256 * 1024, ProtocolOptions.MaximumFrameLength);
Timer = new HashedWheelTimer();
}
public InternalMetricsRegistry(IDriverMetricsProvider driverMetricsProvider, IEnumerable <TMetric> disabledMetrics, bool metricsEnabled)
{
_disabledMetrics = new HashSet <TMetric>(disabledMetrics);
_driverMetricsProvider = driverMetricsProvider;
_metricsEnabled = metricsEnabled;
}
