metrics/osgi/collector/src/main/java/org/apache/felix/metrics/osgi/impl/StartupTimeCalculator.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF 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.
 */
package org.apache.felix.metrics.osgi.impl;

import java.lang.management.ManagementFactory;
import java.time.Clock;
import java.time.Duration;
import java.time.Instant;
import java.util.List;
import java.util.concurrent.Executors;
import java.util.concurrent.Future;
import java.util.concurrent.ScheduledExecutorService;
import java.util.concurrent.TimeUnit;
import java.util.function.Supplier;

import org.apache.felix.metrics.osgi.BundleStartDuration;
import org.apache.felix.metrics.osgi.ServiceRestartCounter;
import org.apache.felix.metrics.osgi.StartupMetrics;
import org.apache.felix.metrics.osgi.StartupMetricsListener;
import org.osgi.framework.BundleContext;
import org.osgi.framework.Constants;
import org.osgi.framework.InvalidSyntaxException;
import org.osgi.framework.ServiceReference;
import org.osgi.util.tracker.ServiceTracker;

public class StartupTimeCalculator {

    // delay activation until the system is marked as ready
    // don't explicitly import the systemready class as this bundle must be started as early as possible in order
    // to record bundle starup times
    
    static final String PROPERTY_READINESS_DELAY = "org.apache.felix.metrics.osgi.additionalReadinessDelayMillis";
    private ServiceTracker<Object, Object> readyTracker;
    private ServiceTracker<StartupMetricsListener, StartupMetricsListener> listenersTracker;
    private BundleStartTimeCalculator bundleCalculator;
    private ServiceRestartCountCalculator serviceCalculator;
    private ScheduledExecutorService executor;
    private Future<Void> future;
    private Supplier<StartupMetrics> metricsSupplier;
    private long additionalReadinessDelayMillis = TimeUnit.SECONDS.toMillis(5);

    public StartupTimeCalculator(BundleContext ctx, BundleStartTimeCalculator bundleCalculator, ServiceRestartCountCalculator serviceCalculator) throws InvalidSyntaxException {
        executor = Executors.newScheduledThreadPool(1);
        try {
            String readinessDelay = ctx.getProperty(PROPERTY_READINESS_DELAY);
            additionalReadinessDelayMillis = Long.parseLong(readinessDelay);
        } catch ( NumberFormatException e) {
            Log.debug(getClass(), "Failed parsing readiness delay", e);
        }
        this.bundleCalculator = bundleCalculator;
        this.serviceCalculator = serviceCalculator;
        this.readyTracker = new ServiceTracker<>(ctx, 
                ctx.createFilter("(|(" + Constants.OBJECTCLASS+"=org.apache.felix.systemready.SystemReady)(&(" + Constants.OBJECTCLASS+ "=org.apache.felix.hc.api.condition.Healthy)(tag=systemalive)))"),
                new ServiceTrackerCustomizerAdapter<Object, Object>() {

                    @Override
                    public Object addingService(ServiceReference<Object> reference) {
                        if ( future == null ) 
                            future = calculate();
                        return ctx.getService(reference);
                    }
                    
                    @Override
                    public void removedService(ServiceReference<Object> reference, Object service) {
                        if ( future != null && !future.isDone() ) {
                            boolean cancelled = future.cancel(false);
                            if ( cancelled ) {
                                metricsSupplier = null;
                                future = null;
                            }
                        }
                    }
                });
        this.readyTracker.open();
        
        this.listenersTracker = new ServiceTracker<>(ctx, StartupMetricsListener.class, new ServiceTrackerCustomizerAdapter<StartupMetricsListener, StartupMetricsListener>() {
            @Override
            public StartupMetricsListener addingService(ServiceReference<StartupMetricsListener> reference) {
                StartupMetricsListener service = ctx.getService(reference);
                // TODO - there is still a minor race condition, between the supplier being set and the registration of services
                // which can cause the listener to receive the event twice
                if ( metricsSupplier != null )
                    service.onStartupComplete(metricsSupplier.get());
                return service;
            }
        });
        this.listenersTracker.open();
    }

    public void close() {
        this.readyTracker.close();
    }

    private Future<Void> calculate() {

        long currentMillis = Clock.systemUTC().millis();
        
        return executor.schedule(() -> {
            long startupMillis = ManagementFactory.getRuntimeMXBean().getStartTime();
            
            Duration startupDuration = Duration.ofMillis(currentMillis - startupMillis);
            Instant startupInstant = Instant.ofEpochMilli(startupMillis);
            List<BundleStartDuration> bundleDurations = bundleCalculator.getBundleStartDurations();
            List<ServiceRestartCounter> serviceRestarts = serviceCalculator.getServiceRestartCounters();
            
            metricsSupplier = () -> {
                return StartupMetrics.Builder.withJvmStartup(startupInstant)
                    .withStartupTime(startupDuration)
                    .withBundleStartDurations(bundleDurations)
                    .withServiceRestarts(serviceRestarts)
                    .build();
            };
            
            for ( StartupMetricsListener listener : listenersTracker.getServices(new StartupMetricsListener[0]) )
                listener.onStartupComplete(metricsSupplier.get());
            
            return null;
        }, additionalReadinessDelayMillis, TimeUnit.MILLISECONDS);
        

    }
}