-
Notifications
You must be signed in to change notification settings - Fork 4.2k
/
DebuggingWordCount.java
185 lines (168 loc) · 7.15 KB
/
DebuggingWordCount.java
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
/*
* 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.beam.examples;
// beam-playground:
// name: DebuggingWordCount
// description: An example that counts words in Shakespeare/kinglear.txt includes regex
// filter("Flourish|stomach").
// multifile: false
// pipeline_options: --output output.txt
// context_line: 180
// categories:
// - Debugging
// - Filtering
// - Options
// - Quickstart
// complexity: MEDIUM
// tags:
// - filter
// - strings
import java.util.Arrays;
import java.util.List;
import java.util.regex.Pattern;
import org.apache.beam.sdk.Pipeline;
import org.apache.beam.sdk.io.TextIO;
import org.apache.beam.sdk.metrics.Counter;
import org.apache.beam.sdk.metrics.Metrics;
import org.apache.beam.sdk.options.Default;
import org.apache.beam.sdk.options.Description;
import org.apache.beam.sdk.options.PipelineOptionsFactory;
import org.apache.beam.sdk.testing.PAssert;
import org.apache.beam.sdk.transforms.DoFn;
import org.apache.beam.sdk.transforms.ParDo;
import org.apache.beam.sdk.values.KV;
import org.apache.beam.sdk.values.PCollection;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
/**
* An example that verifies word counts in Shakespeare and includes Beam best practices.
*
* <p>This class, {@link DebuggingWordCount}, is the third in a series of four successively more
* detailed 'word count' examples. You may first want to take a look at {@link MinimalWordCount} and
* {@link WordCount}. After you've looked at this example, then see the {@link WindowedWordCount}
* pipeline, for introduction of additional concepts.
*
* <p>Basic concepts, also in the MinimalWordCount and WordCount examples: Reading text files;
* counting a PCollection; executing a Pipeline both locally and using a selected runner; defining
* DoFns.
*
* <p>New Concepts:
*
* <pre>
* 1. Logging using SLF4J, even in a distributed environment
* 2. Creating a custom metric (runners have varying levels of support)
* 3. Testing your Pipeline via PAssert
* </pre>
*
* <p>To execute this pipeline locally, specify general pipeline configuration:
*
* <pre>{@code
* --project=YOUR_PROJECT_ID
* }</pre>
*
* <p>To change the runner, specify:
*
* <pre>{@code
* --runner=YOUR_SELECTED_RUNNER
* }</pre>
*
* <p>The input file defaults to a public data set containing the text of King Lear, by William
* Shakespeare. You can override it and choose your own input with {@code --inputFile}.
*/
public class DebuggingWordCount {
/** A DoFn that filters for a specific key based upon a regular expression. */
public static class FilterTextFn extends DoFn<KV<String, Long>, KV<String, Long>> {
/**
* Concept #1: The logger below uses the fully qualified class name of FilterTextFn as the
* logger. Depending on your SLF4J configuration, log statements will likely be qualified by
* this name.
*
* <p>Note that this is entirely standard SLF4J usage. Some runners may provide a default SLF4J
* configuration that is most appropriate for their logging integration.
*/
private static final Logger LOG = LoggerFactory.getLogger(FilterTextFn.class);
private final Pattern filter;
public FilterTextFn(String pattern) {
filter = Pattern.compile(pattern);
}
/**
* Concept #2: A custom metric can track values in your pipeline as it runs. Each runner
* provides varying levels of support for metrics, and may expose them in a dashboard, etc.
*/
private final Counter matchedWords = Metrics.counter(FilterTextFn.class, "matchedWords");
private final Counter unmatchedWords = Metrics.counter(FilterTextFn.class, "unmatchedWords");
@ProcessElement
public void processElement(ProcessContext c) {
if (filter.matcher(c.element().getKey()).matches()) {
// Log at the "DEBUG" level each element that we match. When executing this pipeline
// these log lines will appear only if the log level is set to "DEBUG" or lower.
LOG.debug("Matched: " + c.element().getKey());
matchedWords.inc();
c.output(c.element());
} else {
// Log at the "TRACE" level each element that is not matched. Different log levels
// can be used to control the verbosity of logging providing an effective mechanism
// to filter less important information.
LOG.trace("Did not match: " + c.element().getKey());
unmatchedWords.inc();
}
}
}
/**
* Options supported by {@link DebuggingWordCount}.
*
* <p>Inherits standard configuration options and all options defined in {@link
* WordCount.WordCountOptions}.
*/
public interface WordCountOptions extends WordCount.WordCountOptions {
@Description(
"Regex filter pattern to use in DebuggingWordCount. "
+ "Only words matching this pattern will be counted.")
@Default.String("Flourish|stomach")
String getFilterPattern();
void setFilterPattern(String value);
}
static void runDebuggingWordCount(WordCountOptions options) {
Pipeline p = Pipeline.create(options);
PCollection<KV<String, Long>> filteredWords =
p.apply("ReadLines", TextIO.read().from(options.getInputFile()))
.apply(new WordCount.CountWords())
.apply(ParDo.of(new FilterTextFn(options.getFilterPattern())));
/*
* Concept #3: PAssert is a set of convenient PTransforms in the style of
* Hamcrest's collection matchers that can be used when writing Pipeline level tests
* to validate the contents of PCollections. PAssert is best used in unit tests
* with small data sets but is demonstrated here as a teaching tool.
*
* <p>Below we verify that the set of filtered words matches our expected counts. Note
* that PAssert does not provide any output and that successful completion of the
* Pipeline implies that the expectations were met. Learn more at
* https://beam.apache.org/documentation/pipelines/test-your-pipeline/ on how to test
* your Pipeline and see {@link DebuggingWordCountTest} for an example unit test.
*/
List<KV<String, Long>> expectedResults =
Arrays.asList(KV.of("Flourish", 3L), KV.of("stomach", 1L));
PAssert.that(filteredWords).containsInAnyOrder(expectedResults);
p.run().waitUntilFinish();
}
public static void main(String[] args) {
WordCountOptions options =
PipelineOptionsFactory.fromArgs(args).withValidation().as(WordCountOptions.class);
runDebuggingWordCount(options);
}
}