/* SPDX-License-Identifier: Apache-2.0
*
* The OpenSearch Contributors require contributions made to
* this file be licensed under the Apache-2.0 license or a
* compatible open source license.
*/
/*
* Modifications Copyright OpenSearch Contributors. See
* GitHub history for details.
*
* Licensed to Elasticsearch B.V. under one or more contributor
* license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright
* ownership. Elasticsearch B.V. licenses this file to you under
* the Apache License, Version 2.0 (the "License"); you may
* not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
using System.Diagnostics;
using static OpenSearch.Net.AuditEvent;
namespace OpenSearch.Net
{
public enum AuditEvent
{
SniffOnStartup,
SniffOnFail,
SniffOnStaleCluster,
SniffSuccess,
SniffFailure,
PingSuccess,
PingFailure,
Resurrection,
AllNodesDead,
BadResponse,
HealthyResponse,
MaxTimeoutReached,
MaxRetriesReached,
BadRequest,
NoNodesAttempted,
CancellationRequested,
FailedOverAllNodes,
}
internal static class AuditEventExtensions
{
///
/// Returns the name of the event to be used for use in .
/// If this return null the event should not be reported on
/// This indicates this event is monitored by a different component already
///
/// The diagnostic event name representation or null if it should go unreported
public static string GetAuditDiagnosticEventName(this AuditEvent @event)
{
switch(@event)
{
case SniffFailure:
case SniffSuccess:
case PingFailure:
case PingSuccess:
case BadResponse:
case HealthyResponse:
return null;
case SniffOnStartup: return nameof(SniffOnStartup);
case SniffOnFail: return nameof(SniffOnFail);
case SniffOnStaleCluster: return nameof(SniffOnStaleCluster);
case Resurrection: return nameof(Resurrection);
case AllNodesDead: return nameof(AllNodesDead);
case MaxTimeoutReached: return nameof(MaxTimeoutReached);
case MaxRetriesReached: return nameof(MaxRetriesReached);
case BadRequest: return nameof(BadRequest);
case NoNodesAttempted: return nameof(NoNodesAttempted);
case CancellationRequested: return nameof(CancellationRequested);
case FailedOverAllNodes: return nameof(FailedOverAllNodes);
default: return @event.GetStringValue(); //still cached but uses reflection
}
}
}
}