aboutsummaryrefslogtreecommitdiffstats
path: root/vespa-http-client/src/main/java/com/yahoo/vespa/http/client/SimpleLoggerResultCallback.java
blob: e03bfd2b81639f0afabd4e84659d7d30cfc33877 (plain) (blame)
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
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.vespa.http.client;

import java.time.Duration;
import java.time.Instant;
import java.util.Date;
import java.util.Locale;
import java.util.concurrent.atomic.AtomicInteger;

/**
 * Simple implementation of the ResultCallback that logs to std err for every X documents:
 *   "Result received: 34 (1 failed so far, 2003 sent, success rate 1999.23 docs/sec)."
 * On each failure it will print the Result object content. If tracing is enabled, it will print trace messages to
 * std err as well.
 *
 * @author dybis
 * @deprecated Vespa-http-client will be removed in Vespa 8. It's replaced by <a href="https://docs.vespa.ai/en/vespa-feed-client.html">vespa-feed-client</a>
 */
@Deprecated
public class SimpleLoggerResultCallback implements FeedClient.ResultCallback {

    private final Object monitor = new Object();
    private int resultCounter = 0;
    private int failureCounter = 0;
    private final AtomicInteger sentDocumentCounter;
    private final int printStatsForEveryXDocument;
    private final boolean ignoreConditionNotMet;
    private Instant startSampleInstant = Instant.now();
    private int startSampleResultCount = 0;

    protected void println(String output) {
        System.err.println(output);
    }

    /**
     * Constructor
     *
     * @param sentDocumentCounter a counter that is increased outside this class, but can be nice to print here.
     * @param printStatsForEveryXDocument how often to print stats.
     */
    public SimpleLoggerResultCallback(AtomicInteger sentDocumentCounter, int printStatsForEveryXDocument, boolean ignoreConditionNotMet) {
        this.sentDocumentCounter = sentDocumentCounter;
        this.printStatsForEveryXDocument = printStatsForEveryXDocument;
        this.ignoreConditionNotMet = ignoreConditionNotMet;
    }

    /**
     * Prints how many documents that are received, failed and sent.
     */
    public void printProgress() {
        synchronized (monitor) {
            DocumentRate docRate = newSamplingPeriod(Instant.now());
            println(new Date() + " Result received: " + resultCounter
                    + " (" + failureCounter + " failed so far, " + sentDocumentCounter.get()
                    + " sent, success rate " + docRate + ").");
        }
    }

    static class DocumentRate {
        public final double rate;
        DocumentRate(double rate) {
            this.rate = rate;
        }
        @Override
        public String toString() {
            return String.format(Locale.US, "%.2f docs/sec", rate);
        }
    }

    /*
     * Returns success results per second for last interval and resets variables.
     */
    protected DocumentRate newSamplingPeriod(Instant now) {
        double docsDelta = resultCounter - failureCounter - startSampleResultCount;
        Duration duration = Duration.between(startSampleInstant, now);
        startSampleInstant = now;
        startSampleResultCount = resultCounter - failureCounter;
        long durationMilliSecs = duration.toMillis() + 1; // +1 to avoid division by zero
        return new DocumentRate(1000. * docsDelta / durationMilliSecs);
    }

    int getResultCount() {
        synchronized (monitor) {
            return resultCounter;
        }
    }

    int getFailedDocumentCount() {
        synchronized (monitor) {
            return failureCounter;
        }
    }

    @Override
    public void onCompletion(String docId, Result documentResult) {
        synchronized (monitor) {
            if (printStatsForEveryXDocument > 0 && (resultCounter % printStatsForEveryXDocument) == 0) {
                printProgress();
            }
            resultCounter++;
            boolean success = ignoreConditionNotMet
                    ? documentResult.isSuccessOrConditionNotMet()
                    : documentResult.isSuccess();
            if ( ! success ) {
                failureCounter++;
                println("Failure: " + documentResult + (documentResult.getDetails().isEmpty() ? "" : ":"));
                for (Result.Detail detail : documentResult.getDetails())
                    println("    " + detail);
            }
        }
    }

}