aboutsummaryrefslogtreecommitdiffstats
path: root/catalog-be/src/main/java/org/openecomp/sdc/be/components/distribution/engine/DmaapHealth.java
blob: b48ed78190967dc7cd04f76f014b38e4d866465b (plain)
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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
package org.openecomp.sdc.be.components.distribution.engine;

import org.apache.commons.validator.routines.UrlValidator;
import org.apache.http.client.utils.URIUtils;
import org.openecomp.sdc.be.config.BeEcompErrorManager;
import org.openecomp.sdc.be.config.ConfigurationManager;
import org.openecomp.sdc.be.config.DmaapConsumerConfiguration;
import org.openecomp.sdc.common.api.HealthCheckInfo;
import org.openecomp.sdc.common.log.wrappers.Logger;
import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;
import javax.annotation.PreDestroy;
import java.io.IOException;
import java.net.InetAddress;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.concurrent.Executors;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.ScheduledFuture;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicBoolean;

import static org.apache.commons.lang3.StringUtils.countMatches;
import static org.apache.commons.lang3.StringUtils.isNotBlank;
import static org.openecomp.sdc.common.api.Constants.HC_COMPONENT_DMAAP_ENGINE;

@Component("dmaapHealth")
public class DmaapHealth {


    private static final String DMAAP_HEALTH_LOG_CONTEXT = "dmaap.healthcheck";
    private static final String DMAAP_HEALTH_CHECK_STR = "dmaapHealthCheck";
    private static final Logger log = Logger.getLogger(DmaapHealth.class.getName());
    private static final Logger logHealth = Logger.getLogger(DMAAP_HEALTH_LOG_CONTEXT);
    private HealthCheckInfo healthCheckInfo = DmaapHealth.HealthCheckInfoResult.UNAVAILABLE.getHealthCheckInfo();
    private long healthCheckReadTimeout = 20;
    private long reconnectInterval = 5;
    private HealthCheckScheduledTask healthCheckScheduledTask = null ;
    private final ScheduledExecutorService scheduler = Executors.newScheduledThreadPool(1);
    private ScheduledFuture<?> scheduledFuture = null;
    private DmaapConsumerConfiguration configuration = null ;

    private volatile AtomicBoolean lastHealthState = new AtomicBoolean(false);
    private volatile AtomicBoolean reportedHealthState = null;

    public enum HealthCheckInfoResult {
        OK(new HealthCheckInfo(HC_COMPONENT_DMAAP_ENGINE, HealthCheckInfo.HealthCheckStatus.UP, null, DmaapStatusDescription.OK.getDescription())),
        UNAVAILABLE(new HealthCheckInfo(HC_COMPONENT_DMAAP_ENGINE, HealthCheckInfo.HealthCheckStatus.DOWN, null, DmaapStatusDescription.UNAVAILABLE.getDescription())),
        DOWN(new HealthCheckInfo(HC_COMPONENT_DMAAP_ENGINE, HealthCheckInfo.HealthCheckStatus.DOWN, null, DmaapStatusDescription.DOWN.getDescription()));

        private HealthCheckInfo healthCheckInfo;
        HealthCheckInfoResult(HealthCheckInfo healthCheckInfo) {
            this.healthCheckInfo = healthCheckInfo;
        }
        public HealthCheckInfo getHealthCheckInfo() {
            return healthCheckInfo;
        }
    }

    public enum DmaapStatusDescription {
        OK("OK"), UNAVAILABLE("Dmaap is not available"),DOWN("DOWN"), NOT_CONFIGURED("Dmaap configuration is missing/wrong ");

        private String desc;
        DmaapStatusDescription(String desc) {
            this.desc = desc;
        }
        public String getDescription() {
            return desc;
        }

    }

    @PostConstruct
    public DmaapHealth init() {
        log.trace("Enter init method of Dmaap health");
        synchronized (DmaapHealth.class){
            this.configuration = ConfigurationManager.getConfigurationManager().getConfiguration().getDmaapConsumerConfiguration();

            Integer pollingInterval = configuration.getPollingInterval();
            if (pollingInterval != null && pollingInterval!=0) {
                reconnectInterval = pollingInterval;
            }
            Integer healthCheckReadTimeoutConfig = configuration.getTimeoutMs();
            if (healthCheckReadTimeoutConfig != null) {
                this.healthCheckReadTimeout = healthCheckReadTimeoutConfig;
            }
            this.healthCheckScheduledTask = new HealthCheckScheduledTask( configuration ); //what is the representation? csv? delimiter? json or other
            startHealthCheckTask(true);
        }
        log.trace("Exit init method of DistributionEngineClusterHealth");
        return this;
    }

    @PreDestroy
    protected void destroy() {
        if (scheduledFuture != null) {
            scheduledFuture.cancel(true);
            scheduledFuture = null;
        }
        if (scheduler != null) {
            scheduler.shutdown();
        }
    }

    /**
     * Start health check task.
     *
     * @param startTask
     */
    private void startHealthCheckTask(boolean startTask) {
        synchronized (DmaapHealth.class){
            if (startTask && this.scheduledFuture == null) {
                this.scheduledFuture = this.scheduler.scheduleAtFixedRate(this.healthCheckScheduledTask , 0, reconnectInterval, TimeUnit.SECONDS);
            }
        }
    }

    void report(Boolean isUp){
        if (reportedHealthState == null)
            reportedHealthState = new AtomicBoolean(isUp);
        reportedHealthState.set(isUp);
    }


    public HealthCheckInfo getHealthCheckInfo() {
        return healthCheckInfo;
    }

    /**
     * Health Check Task Scheduler - infinite check.
     */
    public class HealthCheckScheduledTask implements Runnable {
        private final DmaapConsumerConfiguration config;
        private static final int TIMEOUT = 8192;

        HealthCheckScheduledTask(final DmaapConsumerConfiguration config){
            this.config = config;
        }
        @Override
        public void run() {
            logHealth.trace("Executing Dmaap Health Check Task - Start");
            boolean prevIsReachable;
            boolean reachable;
            //first try simple ping
            try{
                if ( reportedHealthState != null ){
                    reachable = reportedHealthState.get();
                }
                else{
                    reachable =  false;
                }
                prevIsReachable = lastHealthState.getAndSet( reachable );
                healthCheckInfo = reachable ? HealthCheckInfoResult.OK.healthCheckInfo : HealthCheckInfoResult.DOWN.healthCheckInfo;
            }
            catch( Exception e ){
                log.debug("{} | cannot check connectivity -> {}",DMAAP_HEALTH_CHECK_STR, e );
                prevIsReachable = lastHealthState.getAndSet(false);
                healthCheckInfo = HealthCheckInfoResult.UNAVAILABLE.healthCheckInfo;
            }
            if (prevIsReachable != lastHealthState.get())
                logAlarm( lastHealthState.get() );
        }


        /**
         * @deprecated (health is reported outside from EnvironmentEngine consumer fetch)
         */
        @Deprecated
        public boolean isICMPReachable( ) throws IOException{
            try{
                String hostname = getUrlHost(config.getHosts());
                return InetAddress.getByName( hostname ).isReachable(TIMEOUT);
            }catch( URISyntaxException e ){
                log.debug("{} | malformed host configuration -> ",DMAAP_HEALTH_CHECK_STR , e);
            }
            return false;
        }

        private void logAlarm(boolean lastHealthState) {
            try{
                if ( lastHealthState ) {
                    BeEcompErrorManager.getInstance().logDmaapHealthCheckRecovery( DMAAP_HEALTH_CHECK_STR );
                } else {
                    BeEcompErrorManager.getInstance().logDmaapHealthCheckError( DMAAP_HEALTH_CHECK_STR );
                }
            }catch( Exception e ){
                log.debug("cannot logAlarm -> {}" ,e );
            }
        }

    }

    public static String getUrlHost(String qualifiedHost) throws URISyntaxException{
        //region - parse complex format ex. <http://URL:PORT>
        try{
            UrlValidator validator = new UrlValidator();
            if (validator.isValid(qualifiedHost)){
                return URIUtils.extractHost(new URI(qualifiedHost)).getHostName();
            }else{
                log.debug("{} | invalid url format, continuing ", DMAAP_HEALTH_CHECK_STR );
            }
        }catch(URISyntaxException e){
            log.debug("{} | invalid url format, continuing {} ", DMAAP_HEALTH_CHECK_STR , e);
        }
        //endregion

        //region - try shortcut format <URL> or <URL:PORT>
        if ( countMatches( qualifiedHost , ":") <= 1){
            String[] address = qualifiedHost.split(":");
            if ( address.length>0 && isNotBlank(address[0]) ){
                return address[0];
            }
        }
        //endregion
        throw new URISyntaxException( qualifiedHost , "invalid hostname, expecting a single <host:port> ,  (valid ex. www.google.com:80 | www.google.com | http:\\\\www.google.com:8181)");
    }
}