1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
/*
* ===============================LICENSE_START======================================
* dcae-analytics
* ================================================================================
* Copyright © 2017 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* Licensed 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.
* ============================LICENSE_END===========================================
*/
package org.openecomp.dcae.apod.analytics.cdap.plugins.sparkcompute.tca;
import co.cask.cdap.api.annotation.Description;
import co.cask.cdap.api.annotation.Name;
import co.cask.cdap.api.annotation.Plugin;
import co.cask.cdap.api.data.format.StructuredRecord;
import co.cask.cdap.api.data.format.StructuredRecord.Builder;
import co.cask.cdap.api.data.schema.Schema;
import co.cask.cdap.etl.api.PipelineConfigurer;
import co.cask.cdap.etl.api.StageMetrics;
import co.cask.cdap.etl.api.batch.SparkCompute;
import co.cask.cdap.etl.api.batch.SparkExecutionPluginContext;
import edu.umd.cs.findbugs.annotations.SuppressFBWarnings;
import org.apache.spark.api.java.JavaRDD;
import org.apache.spark.api.java.function.Function;
import org.openecomp.dcae.apod.analytics.cdap.common.CDAPMetricsConstants;
import org.openecomp.dcae.apod.analytics.cdap.common.persistance.tca.TCACalculatorMessageType;
import org.openecomp.dcae.apod.analytics.cdap.common.utils.ValidationUtils;
import org.openecomp.dcae.apod.analytics.cdap.plugins.domain.config.tca.SimpleTCAPluginConfig;
import org.openecomp.dcae.apod.analytics.cdap.plugins.utils.CDAPPluginUtils;
import org.openecomp.dcae.apod.analytics.cdap.plugins.validator.SimpleTCAPluginConfigValidator;
import org.openecomp.dcae.apod.analytics.model.domain.policy.tca.MetricsPerFunctionalRole;
import org.openecomp.dcae.apod.analytics.model.domain.policy.tca.TCAPolicy;
import org.openecomp.dcae.apod.analytics.model.domain.policy.tca.Threshold;
import org.openecomp.dcae.apod.analytics.tca.processor.TCACEFJsonProcessor;
import org.openecomp.dcae.apod.analytics.tca.processor.TCACEFProcessorContext;
import org.openecomp.dcae.apod.analytics.tca.utils.TCAUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* @author Rajiv Singla . Creation Date: 2/13/2017.
*/
@Plugin(type = SparkCompute.PLUGIN_TYPE)
@Name("SimpleTCAPlugin")
@Description("Used to create TCA (Threshold Crossing Alert) based on given Policy")
@SuppressFBWarnings("SE_INNER_CLASS")
public class SimpleTCAPlugin extends SparkCompute<StructuredRecord, StructuredRecord> {
private static final Logger LOG = LoggerFactory.getLogger(SimpleTCAPlugin.class);
private static final long serialVersionUID = 1L;
private final SimpleTCAPluginConfig pluginConfig;
/**
* Create an instance of Simple TCA Plugin with give Simple TCA Plugin Config
*
* @param pluginConfig Simple TCA Plugin Config
*/
public SimpleTCAPlugin(SimpleTCAPluginConfig pluginConfig) {
this.pluginConfig = pluginConfig;
LOG.info("Creating instance of Simple TCA Plugin with plugin config: {}", pluginConfig);
}
@Override
public void configurePipeline(PipelineConfigurer pipelineConfigurer) {
super.configurePipeline(pipelineConfigurer);
ValidationUtils.validateSettings(pluginConfig, new SimpleTCAPluginConfigValidator());
final Schema inputSchema = pipelineConfigurer.getStageConfigurer().getInputSchema();
CDAPPluginUtils.validateSchemaContainsFields(inputSchema, pluginConfig.getVesMessageFieldName());
CDAPPluginUtils.setOutputSchema(pipelineConfigurer, pluginConfig.getSchema());
}
@Override
public JavaRDD<StructuredRecord> transform(final SparkExecutionPluginContext context,
final JavaRDD<StructuredRecord> input) throws Exception {
final StageMetrics metrics = context.getMetrics();
LOG.debug("Invoking Spark Transform for Simple TCA Plugin");
return input.map(new Function<StructuredRecord, StructuredRecord>() {
@Override
public StructuredRecord call(StructuredRecord inputStructuredRecord) throws Exception {
TCACalculatorMessageType calculatorMessageType;
String alertMessage = null;
// Get input structured record
final String cefMessage = inputStructuredRecord.get(pluginConfig.getVesMessageFieldName());
// Get TCA Policy
final TCAPolicy tcaPolicy = CDAPPluginUtils.readValue(pluginConfig.getPolicyJson(), TCAPolicy.class);
// create initial processor context
final TCACEFProcessorContext initialProcessorContext =
new TCACEFProcessorContext(cefMessage, tcaPolicy);
final TCACEFJsonProcessor jsonProcessor = new TCACEFJsonProcessor();
final TCACEFProcessorContext jsonProcessorContext =
jsonProcessor.processMessage(initialProcessorContext);
if (jsonProcessorContext.getCEFEventListener() != null) {
LOG.debug("Json to CEF parsing successful. Parsed object {}",
jsonProcessorContext.getCEFEventListener());
// compute violations
final TCACEFProcessorContext processorContextWithViolations =
TCAUtils.computeThresholdViolations(jsonProcessorContext);
// if violation are found then create alert message
if (processorContextWithViolations.canProcessingContinue()) {
alertMessage = TCAUtils.createTCAAlertString(processorContextWithViolations,
pluginConfig.getReferenceName(), pluginConfig.getEnableAlertCEFFormat());
calculatorMessageType = TCACalculatorMessageType.NON_COMPLIANT;
LOG.debug("VES Threshold Violation Detected.An alert message is be generated: {}",
alertMessage);
final MetricsPerFunctionalRole metricsPerFunctionalRole =
processorContextWithViolations.getMetricsPerFunctionalRole();
if (metricsPerFunctionalRole != null
&& metricsPerFunctionalRole.getThresholds() != null
&& metricsPerFunctionalRole.getThresholds().get(0) != null) {
final Threshold violatedThreshold = metricsPerFunctionalRole.getThresholds().get(0);
LOG.debug("CEF Message: {}, Violated Threshold: {}", cefMessage, violatedThreshold);
}
metrics.count(CDAPMetricsConstants.TCA_VES_NON_COMPLIANT_MESSAGES_METRIC, 1);
} else {
LOG.debug("No Threshold Violation Detected. No alert will be generated.");
calculatorMessageType = TCACalculatorMessageType.COMPLIANT;
metrics.count(CDAPMetricsConstants.TCA_VES_COMPLIANT_MESSAGES_METRIC, 1);
}
} else {
LOG.info("Unable to parse provided json message to CEF format. Invalid message: {}", cefMessage);
calculatorMessageType = TCACalculatorMessageType.INAPPLICABLE;
}
LOG.debug("Calculator message type: {} for message: {}", calculatorMessageType, cefMessage);
final Schema outputSchema = Schema.parseJson(pluginConfig.getSchema());
// create new output record builder and copy any input record values to output record builder
final Builder outputRecordBuilder =
CDAPPluginUtils.createOutputStructuredRecordBuilder(outputSchema, inputStructuredRecord);
// add alert field
final Builder outputRecordBuilderWithAlertField =
CDAPPluginUtils.addFieldValueToStructuredRecordBuilder(outputRecordBuilder,
outputSchema, pluginConfig.getAlertFieldName(), alertMessage);
// add message field type
final Builder outRecordBuilderWithMessageTypeField =
CDAPPluginUtils.addFieldValueToStructuredRecordBuilder(outputRecordBuilderWithAlertField,
outputSchema, pluginConfig.getMessageTypeFieldName(), calculatorMessageType.toString());
return outRecordBuilderWithMessageTypeField.build();
}
});
}
}
|
