Skip to content

Commit 2a1eab3

Browse files
kpflemingkpfleming
authored
[CDTOOL-1069] fix(logging): Improve documentation of Region and ProcessingRegion fields. (#690)
NOTE: `logging_logentries.go` was intentionally skipped as that service is no longer supported by Fastly and support for it should be removed from go-fastly. All Submissions: * [X] Have you followed the guidelines in our Contributing document? * [X] Have you checked to ensure there aren't other open [Pull Requests](https://github.com/fastly/go-fastly/pulls) for the same update/change? <!-- You can erase any parts of this template not applicable to your Pull Request. --> ### New Feature Submissions: * [ ] Does your submission pass tests? ### Changes to Core Features: * [ ] Have you added an explanation of what your changes do and why you'd like us to include them? * [ ] Have you written new tests for your core changes, as applicable? * [ ] Have you successfully run tests with your changes locally? ### User Impact * [ ] What is the user impact of this change? ### Are there any considerations that need to be addressed for release? <!-- Any breaking changes, etc -->
1 parent 1a29148 commit 2a1eab3

28 files changed

+63
-62
lines changed

‎CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
- feat(ngwaf): add support for timeseries ([#689](https://github.com/fastly/go-fastly/pull/689))
1111

1212
### Bug fixes:
13+
- fix(logging): Improve documentation of Region and ProcessingRegion fields. ([#690](https://github.com/fastly/go-fastly/pull/690))
1314

1415
### Dependencies:
1516

‎fastly/logging_bigquery.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ type CreateBigQueryInput struct {
7878
Name *string `url:"name,omitempty"`
7979
// Placement is where in the generated VCL the logging call should be placed.
8080
Placement *string `url:"placement,omitempty"`
81-
// ProcessingRegion is the Fastly region where logs will be processed before streaming to the endpoint.
81+
// ProcessingRegion is the region where logs will be processed before streaming to BigQuery.
8282
ProcessingRegion *string `url:"log_processing_region,omitempty"`
8383
// ProjectID is your Google Cloud Platform project ID.
8484
ProjectID *string `url:"project_id,omitempty"`
@@ -177,7 +177,7 @@ type UpdateBigQueryInput struct {
177177
NewName *string `url:"name,omitempty"`
178178
// Placement is where in the generated VCL the logging call should be placed.
179179
Placement *string `url:"placement,omitempty"`
180-
// ProcessingRegion is the Fastly region where logs will be processed before streaming to the endpoint.
180+
// ProcessingRegion is the region where logs will be processed before streaming to BigQuery.
181181
ProcessingRegion *string `url:"log_processing_region,omitempty"`
182182
// ProjectID is your Google Cloud Platform project ID.
183183
ProjectID *string `url:"project_id,omitempty"`

‎fastly/logging_blobstorage.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ type CreateBlobStorageInput struct {
9393
Period *int `url:"period,omitempty"`
9494
// Placement is where in the generated VCL the logging call should be placed.
9595
Placement *string `url:"placement,omitempty"`
96-
// ProcessingRegion is the Fastly region where logs will be processed before streaming to the endpoint.
96+
// ProcessingRegion is the region where logs will be processed before streaming to Azure Blob Storage.
9797
ProcessingRegion *string `url:"log_processing_region,omitempty"`
9898
// PublicKey is a PGP public key that Fastly will use to encrypt your log files before writing them to disk.
9999
PublicKey *string `url:"public_key,omitempty"`
@@ -200,7 +200,7 @@ type UpdateBlobStorageInput struct {
200200
Period *int `url:"period,omitempty"`
201201
// Placement is where in the generated VCL the logging call should be placed.
202202
Placement *string `url:"placement,omitempty"`
203-
// ProcessingRegion is the Fastly region where logs will be processed before streaming to the endpoint.
203+
// ProcessingRegion is the region where logs will be processed before streaming to Azure Blob Storage.
204204
ProcessingRegion *string `url:"log_processing_region,omitempty"`
205205
// PublicKey is a PGP public key that Fastly will use to encrypt your log files before writing them to disk.
206206
PublicKey *string `url:"public_key,omitempty"`

‎fastly/logging_cloudfiles.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,11 +91,11 @@ type CreateCloudfilesInput struct {
9191
Period *int `url:"period,omitempty"`
9292
// Placement is where in the generated VCL the logging call should be placed.
9393
Placement *string `url:"placement,omitempty"`
94-
// ProcessingRegion is the Fastly region where logs will be processed before streaming to the endpoint.
94+
// ProcessingRegion is the region where logs will be processed before streaming to Cloud Files.
9595
ProcessingRegion *string `url:"log_processing_region,omitempty"`
9696
// PublicKey is a PGP public key that Fastly will use to encrypt your log files before writing them to disk.
9797
PublicKey *string `url:"public_key,omitempty"`
98-
// Region is the region to stream logs to.
98+
// Region is the region where logs are received and stored by Cloud Files.
9999
Region *string `url:"region,omitempty"`
100100
// ResponseCondition is the name of an existing condition in the configured endpoint, or leave blank to always execute.
101101
ResponseCondition *string `url:"response_condition,omitempty"`
@@ -198,11 +198,11 @@ type UpdateCloudfilesInput struct {
198198
Period *int `url:"period,omitempty"`
199199
// Placement is where in the generated VCL the logging call should be placed.
200200
Placement *string `url:"placement,omitempty"`
201-
// ProcessingRegion is the Fastly region where logs will be processed before streaming to the endpoint.
201+
// ProcessingRegion is the Fastly region where logs will be processed before streaming to Cloud Files.
202202
ProcessingRegion *string `url:"log_processing_region,omitempty"`
203203
// PublicKey is a PGP public key that Fastly will use to encrypt your log files before writing them to disk.
204204
PublicKey *string `url:"public_key,omitempty"`
205-
// Region is the region to stream logs to.
205+
// Region is the region where logs are received and stored by Cloud Files.
206206
Region *string `url:"region,omitempty"`
207207
// ResponseCondition is the name of an existing condition in the configured endpoint, or leave blank to always execute.
208208
ResponseCondition *string `url:"response_condition,omitempty"`

‎fastly/logging_datadog.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,9 +68,9 @@ type CreateDatadogInput struct {
6868
Name *string `url:"name,omitempty"`
6969
// Placement is where in the generated VCL the logging call should be placed.
7070
Placement *string `url:"placement,omitempty"`
71-
// ProcessingRegion is the Fastly region where logs will be processed before streaming to the endpoint.
71+
// ProcessingRegion is the region where logs will be processed before streaming to Datadog.
7272
ProcessingRegion *string `url:"log_processing_region,omitempty"`
73-
// Region is the region that log data will be sent to.
73+
// Region is the region where logs are received and stored by Datadog.
7474
Region *string `url:"region,omitempty"`
7575
// ResponseCondition is the name of an existing condition in the configured endpoint, or leave blank to always execute.
7676
ResponseCondition *string `url:"response_condition,omitempty"`
@@ -157,9 +157,9 @@ type UpdateDatadogInput struct {
157157
NewName *string `url:"name,omitempty"`
158158
// Placement is where in the generated VCL the logging call should be placed.
159159
Placement *string `url:"placement,omitempty"`
160-
// ProcessingRegion is the Fastly region where logs will be processed before streaming to the endpoint.
160+
// ProcessingRegion is the region where logs will be processed before streaming to Datadog.
161161
ProcessingRegion *string `url:"log_processing_region,omitempty"`
162-
// Region is the region that log data will be sent to.
162+
// Region is the region where logs are received and stored by Datadog.
163163
Region *string `url:"region,omitempty"`
164164
// ResponseCondition is the name of an existing condition in the configured endpoint, or leave blank to always execute.
165165
ResponseCondition *string `url:"response_condition,omitempty"`

‎fastly/logging_digitalocean.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ type CreateDigitalOceanInput struct {
9393
Period *int `url:"period,omitempty"`
9494
// Placement is where in the generated VCL the logging call should be placed.
9595
Placement *string `url:"placement,omitempty"`
96-
// ProcessingRegion is the Fastly region where logs will be processed before streaming to the endpoint.
96+
// ProcessingRegion is the region where logs will be processed before streaming to Digital Ocean.
9797
ProcessingRegion *string `url:"log_processing_region,omitempty"`
9898
// PublicKey is a PGP public key that Fastly will use to encrypt your log files before writing them to disk.
9999
PublicKey *string `url:"public_key,omitempty"`
@@ -200,7 +200,7 @@ type UpdateDigitalOceanInput struct {
200200
Period *int `url:"period,omitempty"`
201201
// Placement is where in the generated VCL the logging call should be placed.
202202
Placement *string `url:"placement,omitempty"`
203-
// ProcessingRegion is the Fastly region where logs will be processed before streaming to the endpoint.
203+
// ProcessingRegion is the region where logs will be processed before streaming to Digital Ocean.
204204
ProcessingRegion *string `url:"log_processing_region,omitempty"`
205205
// PublicKey is a PGP public key that Fastly will use to encrypt your log files before writing them to disk.
206206
PublicKey *string `url:"public_key,omitempty"`

‎fastly/logging_elasticsearch.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ type CreateElasticsearchInput struct {
8383
Pipeline *string `url:"pipeline,omitempty"`
8484
// Placement is where in the generated VCL the logging call should be placed.
8585
Placement *string `url:"placement,omitempty"`
86-
// ProcessingRegion is the Fastly region where logs will be processed before streaming to the endpoint.
86+
// ProcessingRegion is the region where logs will be processed before streaming to Elasticsearch.
8787
ProcessingRegion *string `url:"log_processing_region,omitempty"`
8888
// RequestMaxBytes is the maximum number of bytes sent in one request.
8989
RequestMaxBytes *int `url:"request_max_bytes,omitempty"`
@@ -192,7 +192,7 @@ type UpdateElasticsearchInput struct {
192192
Pipeline *string `url:"pipeline,omitempty"`
193193
// Placement is where in the generated VCL the logging call should be placed.
194194
Placement *string `url:"placement,omitempty"`
195-
// ProcessingRegion is the Fastly region where logs will be processed before streaming to the endpoint.
195+
// ProcessingRegion is the region where logs will be processed before streaming to Elasticsearch.
196196
ProcessingRegion *string `url:"log_processing_region,omitempty"`
197197
// RequestMaxBytes is the maximum number of bytes sent in one request.
198198
RequestMaxBytes *int `url:"request_max_bytes,omitempty"`

‎fastly/logging_ftp.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ type CreateFTPInput struct {
9393
Placement *string `url:"placement,omitempty"`
9494
// Port is the port number.
9595
Port *int `url:"port,omitempty"`
96-
// ProcessingRegion is the Fastly region where logs will be processed before streaming to the endpoint.
96+
// ProcessingRegion is the region where logs will be processed before streaming to the FTP endpoint.
9797
ProcessingRegion *string `url:"log_processing_region,omitempty"`
9898
// PublicKey is a PGP public key that Fastly will use to encrypt your log files before writing them to disk.
9999
PublicKey *string `url:"public_key,omitempty"`
@@ -200,7 +200,7 @@ type UpdateFTPInput struct {
200200
Placement *string `url:"placement,omitempty"`
201201
// Port is the port number.
202202
Port *int `url:"port,omitempty"`
203-
// ProcessingRegion is the Fastly region where logs will be processed before streaming to the endpoint.
203+
// ProcessingRegion is the region where logs will be processed before streaming to the FTP endpoint.
204204
ProcessingRegion *string `url:"log_processing_region,omitempty"`
205205
// PublicKey is a PGP public key that Fastly will use to encrypt your log files before writing them to disk.
206206
PublicKey *string `url:"public_key,omitempty"`

‎fastly/logging_gcs.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ type CreateGCSInput struct {
9191
Period *int `url:"period,omitempty"`
9292
// Placement is where in the generated VCL the logging call should be placed.
9393
Placement *string `url:"placement,omitempty"`
94-
// ProcessingRegion is the Fastly region where logs will be processed before streaming to the endpoint.
94+
// ProcessingRegion is the region where logs will be processed before streaming to Google Cloud Storage.
9595
ProcessingRegion *string `url:"log_processing_region,omitempty"`
9696
// ProjectID is your Google Cloud Platform project ID. Not required if user and secret_key are present.
9797
ProjectID *string `url:"project_id,omitempty"`
@@ -198,7 +198,7 @@ type UpdateGCSInput struct {
198198
Period *int `url:"period,omitempty"`
199199
// Placement is where in the generated VCL the logging call should be placed.
200200
Placement *string `url:"placement,omitempty"`
201-
// ProcessingRegion is the Fastly region where logs will be processed before streaming to the endpoint.
201+
// ProcessingRegion is the region where logs will be processed before streaming to Google Cloud Storage.
202202
ProcessingRegion *string `url:"log_processing_region,omitempty"`
203203
// ProjectID is your Google Cloud Platform project ID. Not required if user and secret_key are provided.
204204
ProjectID *string `url:"project_id,omitempty"`

‎fastly/logging_grafanacloudlogs.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ type CreateGrafanaCloudLogsInput struct {
7474
MessageType *string `url:"message_type,omitempty"`
7575
// Placement is where in the generated VCL the logging call should be placed.
7676
Placement *string `url:"placement,omitempty"`
77-
// ProcessingRegion is the Fastly region where logs will be processed before streaming to the endpoint.
77+
// ProcessingRegion is the region where logs will be processed before streaming to Grafana Cloud Logs.
7878
ProcessingRegion *string `url:"log_processing_region,omitempty"`
7979
// ResponseCondition is the name of an existing condition in the configured endpoint, or leave blank to always execute.
8080
ResponseCondition *string `url:"response_condition,omitempty"`
@@ -169,7 +169,7 @@ type UpdateGrafanaCloudLogsInput struct {
169169
MessageType *string `url:"message_type,omitempty"`
170170
// Placement is where in the generated VCL the logging call should be placed.
171171
Placement *string `url:"placement,omitempty"`
172-
// ProcessingRegion is the Fastly region where logs will be processed before streaming to the endpoint.
172+
// ProcessingRegion is the region where logs will be processed before streaming to Grafana Cloud Logs.
173173
ProcessingRegion *string `url:"log_processing_region,omitempty"`
174174
// ResponseCondition is the name of an existing condition in the configured endpoint, or leave blank to always execute.
175175
ResponseCondition *string `url:"response_condition,omitempty"`

0 commit comments

Comments
 (0)