Skip to content

Commit db2b1c6

Browse files
authored
Fix spelling (#5518)
1 parent 368dd80 commit db2b1c6

File tree

8 files changed

+24
-24
lines changed

8 files changed

+24
-24
lines changed

.github/workflows/README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,20 @@
22

33
There are a few [GitHub secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets) to configure to fully leverage the build.
44

5-
You can use and set the followings secrets also in your fork.
5+
You can use and set the following secrets also in your fork.
66

77
## Ngrok Debugging
88

99
You can debug a GitHub Action build using [NGROK](https://ngrok.com/).
1010

1111
It is disabled for automated build triggered by push and pull_requests.
1212

13-
You can trigger a workflow run manually enabling ngrok debugging.
13+
You can trigger a workflow run manually enabling ngrok debugging.
1414

1515
It will open an ssh connection to the VM and keep it up and running for one hour.
16-
The connection url is showns in the log for debugAction.sh
16+
The connection URL is shown in the log for debugAction.sh
1717

18-
You can then connect to the build vm, and debug it.
18+
You can then connect to the build VM, and debug it.
1919
You need to use a password of your choice to access it.
2020

2121
You can continue the build with `touch /tmp/continue`.
@@ -30,7 +30,7 @@ Then set the following secrets:
3030

3131
## Log Upload
3232

33-
The build uploads the logs to an s3 bucket allowing to inspect them with a browser.
33+
The build uploads the logs to a S3 bucket allowing to inspect them with a browser.
3434

3535
You need to create the bucket with the following commands:
3636

@@ -53,4 +53,4 @@ To enable upload to the created bucket you need to set the following secrets:
5353

5454
If you want to get notified of what happens on slack, create an [Incoming Web Hook](https://api.slack.com/messaging/webhooks) and then set the following secret:
5555

56-
- `SLACK_WEBHOOK`: the incoming webhook url provided by slack.
56+
- `SLACK_WEBHOOK`: the incoming webhook URL provided by slack.

ansible/group_vars/all

+1-1
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ nginx:
273273

274274
# These are the variables to define all database relevant settings.
275275
# The authKeys are the users, that are initially created to use OpenWhisk.
276-
# The keys are stored in ansible/files and will be inserted into the authentication databse.
276+
# The keys are stored in ansible/files and will be inserted into the authentication database.
277277
# The key db.whisk.actions is the name of the database where all artifacts of the user are stored. These artifacts are actions, triggers, rules and packages.
278278
# The key db.whisk.activation is the name of the database where all activations are stored.
279279
# The key db.whisk.auth is the name of the authentication database where all keys of all users are stored.

ansible/publish.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
#
1717
---
1818
# This playbook updates CLIs and SDKs on an existing edge host.
19-
# Artifacts get built and published to NGINX. This assumes an already running egde host in an Openwhisk deployment.
19+
# Artifacts get built and published to NGINX. This assumes an already running edge host in an Openwhisk deployment.
2020

2121
- hosts: edge
2222
roles:

common/scala/src/main/resources/application.conf

+6-6
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ whisk {
149149
acks = 1
150150
request-timeout-ms = 30000
151151
metadata-max-age-ms = 15000
152-
# max-request-size is defined programatically for producers related to the "completed" and "invoker" topics
152+
# max-request-size is defined programmatically for producers related to the "completed" and "invoker" topics
153153
# as ${whisk.activation.kafka.payload.max} + ${whisk.activation.kafka.serdes-overhead}. All other topics use
154154
# the default of 1 MB.
155155
}
@@ -182,14 +182,14 @@ whisk {
182182
segment-bytes = 536870912
183183
retention-bytes = 1073741824
184184
retention-ms = 3600000
185-
# max-message-bytes is defined programatically as ${whisk.activation.kafka.payload.max} +
185+
# max-message-bytes is defined programmatically as ${whisk.activation.kafka.payload.max} +
186186
# ${whisk.activation.kafka.serdes-overhead}.
187187
}
188188
creationAck {
189189
segment-bytes = 536870912
190190
retention-bytes = 1073741824
191191
retention-ms = 3600000
192-
# max-message-bytes is defined programatically as ${whisk.activation.kafka.payload.max} +
192+
# max-message-bytes is defined programmatically as ${whisk.activation.kafka.payload.max} +
193193
# ${whisk.activation.kafka.serdes-overhead}.
194194
}
195195
health {
@@ -201,7 +201,7 @@ whisk {
201201
segment-bytes = 536870912
202202
retention-bytes = 1073741824
203203
retention-ms = 172800000
204-
# max-message-bytes is defined programatically as ${whisk.activation.kafka.payload.max} +
204+
# max-message-bytes is defined programmatically as ${whisk.activation.kafka.payload.max} +
205205
# ${whisk.activation.kafka.serdes-overhead}.
206206
}
207207
events {
@@ -586,9 +586,9 @@ whisk {
586586
cache-expiry = 30 seconds #how long to keep spans in cache. Set to appropriate value to trace long running requests
587587
#Zipkin configuration. Uncomment following to enable zipkin based tracing
588588
#zipkin {
589-
# url = "http://localhost:9411" //url to connecto to zipkin server
589+
# url = "http://localhost:9411" //URL to connect to zipkin server
590590
//sample-rate to decide a request is sampled or not.
591-
//sample-rate 0.5 eqauls to sampling 50% of the requests
591+
//sample-rate 0.5 equals to sampling 50% of the requests
592592
//sample-rate of 1 means 100% sampling.
593593
//sample-rate of 0 means no sampling
594594
# sample-rate = "0.01" // sample 1% of requests by default

common/scala/src/main/scala/org/apache/openwhisk/core/ack/MessagingActiveAck.scala

+1-1
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ class MessagingActiveAck(producer: MessageProducer, instance: InstanceId, eventS
6161

6262
// An acknowledgement containing the result is only needed for blocking invokes in order to further the
6363
// continuation. A result message for a non-blocking activation is not actually registered in the load balancer
64-
// and the container proxy should not send such an acknowlegement unless it's a blocking request. Here the code
64+
// and the container proxy should not send such an acknowledgement unless it's a blocking request. Here the code
6565
// is defensive and will shrink all non-blocking acknowledgements.
6666
send(if (blockingInvoke) acknowledgement else acknowledgement.shrink).recoverWith {
6767
case t if t.getCause.isInstanceOf[RecordTooLargeException] =>

common/scala/src/main/scala/org/apache/openwhisk/core/connector/Message.scala

+2-2
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ abstract class AcknowledgementMessage(private val tid: TransactionId) extends Me
115115
* combines the `CompletionMessage` and `ResultMessage`. The `response` may be an `ActivationId` to allow for failures
116116
* to send the activation result because of event-bus size limitations.
117117
*
118-
* The constructor is private so that callers must use the more restrictive constructors which ensure the respose is always
118+
* The constructor is private so that callers must use the more restrictive constructors which ensure the response is always
119119
* Right when this message is created.
120120
*/
121121
case class CombinedCompletionAndResultMessage private (override val transid: TransactionId,
@@ -167,7 +167,7 @@ case class CompletionMessage private (override val transid: TransactionId,
167167
* This is part of a split phase notification, and does not indicate that the slot is available, which is indicated with
168168
* a `CompletionMessage`. Note that activation record will not contain any logs from the action execution, only the result.
169169
*
170-
* The constructor is private so that callers must use the more restrictive constructors which ensure the respose is always
170+
* The constructor is private so that callers must use the more restrictive constructors which ensure the response is always
171171
* Right when this message is created.
172172
*/
173173
case class ResultMessage private (override val transid: TransactionId, response: Either[ActivationId, WhiskActivation])

common/scala/src/main/scala/org/apache/openwhisk/core/containerpool/Container.scala

+1-1
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ trait Container {
139139
endTime = r.interval.end,
140140
logLevel = InfoLevel)
141141
case Failure(t) =>
142-
transid.failed(this, start, s"initializiation failed with $t")
142+
transid.failed(this, start, s"initialization failed with $t")
143143
}
144144
.flatMap { result =>
145145
// if runtime container is shutting down, reschedule the activation message

tools/owperf/README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ This test tool benchmarks an OpenWhisk deployment for (warm) latency and through
2626
1. Parameter size - controls the size of the parameter passed to the action or event
2727
1. Actions per iteration (a.k.a. _ratio_) - controls how many rules are associated with a trigger [for rules] or how many actions are asynchronously invoked (burst size) at each iteration of a test worker [for actions].
2828
1. "Master apart" mode - Allow the master client to perform latency measurements while the worker clients stress OpenWhisk using a specific invocation pattern in the background. Useful for measuring latency under load, and for comparing latencies of rules and actions under load.
29-
The tool is written in node.js, using mainly the modules of OpenWhisk client, cluster for concurrency, and commander for CLI procssing.
29+
The tool is written in node.js, using mainly the modules of OpenWhisk client, cluster for concurrency, and commander for CLI processing.
3030

3131
### Operation
3232
The general operation of a test is simple:
@@ -39,11 +39,11 @@ The general operation of a test is simple:
3939

4040
Final results are written to the standard output stream (so can be redirected to a file) as a single highly-detailed CSV record containing all the input settings and the output measurements (see below). There is additional control information that is written to the standard error stream and can be silenced in CLI. The control information also contains the CSV header, so it can be copied into a spreadsheet if needed.
4141

42-
It is possible to invoke the tool in "Master apart" mode, where the master client is invoking a different activity than the workers, and at possibly a different (very likely, much slower) rate. In this mode, latency statsitics are computed based solely on the master's data, since the worker's activity is used only as background to stress the OpenWhisk deployment. So one experiment can have the master client invoke rules and another one can have the master client invoke actions, while in both experiments the worker clients perform the same background activity.
42+
It is possible to invoke the tool in "Master apart" mode, where the master client is invoking a different activity than the workers, and at possibly a different (very likely, much slower) rate. In this mode, latency statistics are computed based solely on the master's data, since the worker's activity is used only as background to stress the OpenWhisk deployment. So one experiment can have the master client invoke rules and another one can have the master client invoke actions, while in both experiments the worker clients perform the same background activity.
4343

4444
The tool is highly customizable via CLI options. All the independent test variables are controlled via CLI. This includes number of workers, invocation pattern, OW client configuration, test action sleep time, etc.
4545

46-
Test setup and teardown can be independently skipped via CLI, and/or directly invoked from the external setup script (```setup.sh```), so that setup can be shared between multiple tests. More advanced users can replace the test action with a custom action in the setup script to benchmark action invocation or event-respose throughput and latency of specific applications.
46+
Test setup and teardown can be independently skipped via CLI, and/or directly invoked from the external setup script (```setup.sh```), so that setup can be shared between multiple tests. More advanced users can replace the test action with a custom action in the setup script to benchmark action invocation or event-response throughput and latency of specific applications.
4747

4848
**Clock skew**: OpenWhisk is a distributed system, which means that clock skew is expected between the client machine computing invocation timestamps and the controllers or invokers that generate the timestamps in the activation records. However, this tool assumes that clock skew is bound at few msec range, due to having all machines clocks synchronized, typically using NTP. At such a scale, clock skew is quite small compared to the measured time periods. Some of the time periods are measured using the same clock (see below) and are therefore oblivious to clock skew issues.
4949

@@ -67,7 +67,7 @@ The following time-stamps are collected for each invocation, of either action, o
6767
* **TS** (Trigger Start) - taken from the activation record of the trigger linked to the rules, so applies only to rule tests. All actions invoked by the rules of the same trigger have the same TS value.
6868
* **AS** (Action Start) - taken from the activation record of the action.
6969
* **AE** (Action End) - taken from the activation record of the action.
70-
* **AI** (After Invocation) - taken by the client immmediately after the invocation, for blocking action invocation tests only.
70+
* **AI** (After Invocation) - taken by the client immediately after the invocation, for blocking action invocation tests only.
7171

7272
Based on these timestamps, the following measurements are taken:
7373
* **OEA** (Overhead of Entering Action) - OpenWhisk processing overhead from sending the action invocation or trigger fire to the beginning of the action execution. OEA = AS-BI
@@ -77,7 +77,7 @@ Based on these timestamps, the following measurements are taken:
7777
* **TA** (Trigger to Answer) - the processing time from the start of the trigger process to the start of the action (rule tests only). TA = AS-TS
7878
* **ORA** (Overhead of Returning from Action) - time from action end till being received by the client (blocking action tests only). ORA = AI - AE
7979
* **RTT** (Round Trip Time) - time at the client from action invocation till reply received (blocking action tests only). RTT = AI - BI
80-
* **ORTT** (Overhead of RTT) - RTT at the client exclugin the net action computation time. ORTT = RTT - D
80+
* **ORTT** (Overhead of RTT) - RTT at the client excluding the net action computation time. ORTT = RTT - D
8181

8282
For each measurement, the tool computes average (_avg_), standard deviation (_std_), and extremes (_min_ and _max_).
8383

@@ -92,7 +92,7 @@ Throughput is measured w.r.t. several different counters. During post-processing
9292
* **Activations** - number of completed activations inside the time frame, counting both trigger activations (based on TS), and action activations (based on AS and AE).
9393
* **Invocations** - number of successful invocations of complete rules or actions (depending on the activity). This is the "service rate" of invocations (assuming errors happen only because OW is overloaded).
9494

95-
For each counter, the tool reports the total counter value (_abs_), total throughput per second (_tp_), througput of the worker clients without the master (_tpw_) and the master's percentage of throughput relative to workers (_tpd_). The last two values are important mostly for master apart mode.
95+
For each counter, the tool reports the total counter value (_abs_), total throughput per second (_tp_), throughput of the worker clients without the master (_tpw_) and the master's percentage of throughput relative to workers (_tpd_). The last two values are important mostly for master apart mode.
9696

9797
Aside from that, the tool also counts **errors**. Failed invocations - of actions, of triggers, or of actions from triggers (via rules) are counted each as an error. The tool reports both absolute error count (_abs_) and percent out of requests (_percent_).
9898

0 commit comments

Comments
 (0)