Class: Fastly::LoggingNewrelicApi

Inherits:
Object
  • Object
show all
Defined in:
lib/fastly/api/logging_newrelic_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ LoggingNewrelicApi

Returns a new instance of LoggingNewrelicApi.



17
18
19
 
# File 'lib/fastly/api/logging_newrelic_api.rb', line 17

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



15
16
17
 
# File 'lib/fastly/api/logging_newrelic_api.rb', line 15

def api_client
  @api_client
end

Instance Method Details

#create_log_newrelic(opts = {}) ⇒ LoggingNewrelicResponse

Create a New Relic log endpoint Create a New Relic Logs logging object for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :name (String) —

    The name for the real-time logging configuration.

  • :placement (String) —

    Where in the generated VCL the logging call should be placed. If not set, endpoints with `format_version` of 2 are placed in `vcl_log` and those with `format_version` of 1 are placed in `vcl_deliver`.

  • :response_condition (String) —

    The name of an existing condition in the configured endpoint, or leave blank to always execute.

  • :format (String) —

    A Fastly [log format string](docs.fastly.com/en/guides/custom-log-formats). Must produce valid JSON that New Relic Logs can ingest. (default to ‘"timestamp":"%{begin:%Y-%m-%dT%H:%M:%St","time_elapsed":"%Fastly::LoggingNewrelicApi.timetime.elapsedtime.elapsed.usecV","is_tls":"%\"true\", \"false\")V","client_ip":"%Fastly::LoggingNewrelicApi.reqreq.httpreq.http.Fastly-Client-IPV","geo_city":"%Fastly::LoggingNewrelicApi.clientclient.geoclient.geo.cityV","geo_country_code":"%Fastly::LoggingNewrelicApi.clientclient.geoclient.geo.country_codeV","request":"%Fastly::LoggingNewrelicApi.reqreq.requestV","host":"%Fastly::LoggingNewrelicApi.reqreq.httpreq.http.Fastly-Orig-HostV","url":"%Fastly::LoggingNewrelicApi.jsonjson.escape(reqjson.escape(req.url)V","request_referer":"%Fastly::LoggingNewrelicApi.jsonjson.escape(reqjson.escape(req.httpjson.escape(req.http.Referer)V","request_user_agent":"%Fastly::LoggingNewrelicApi.jsonjson.escape(reqjson.escape(req.httpjson.escape(req.http.User-Agent)V","request_accept_language":"%Fastly::LoggingNewrelicApi.jsonjson.escape(reqjson.escape(req.httpjson.escape(req.http.Accept-Language)V","request_accept_charset":"%Fastly::LoggingNewrelicApi.jsonjson.escape(reqjson.escape(req.httpjson.escape(req.http.Accept-Charset)V","cache_status":"%{regsub(fastly_info.state, \"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\", \"\\2\\3\") }V"}’)

  • :format_version (Integer) —

    The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. (default to FORMAT_VERSION::v2)

  • :token (String) —

    The Insert API key from the Account page of your New Relic account. Required.

  • :region (String) —

    The region to which to stream logs. (default to ‘US’)

Returns:



32
33
34
35
 
# File 'lib/fastly/api/logging_newrelic_api.rb', line 32

def create_log_newrelic(opts = {})
  data, _status_code, _headers = create_log_newrelic_with_http_info(opts)
  data
end

#create_log_newrelic_with_http_info(opts = {}) ⇒ Array<(LoggingNewrelicResponse, Integer, Hash)>

Create a New Relic log endpoint Create a New Relic Logs logging object for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :name (String) —

    The name for the real-time logging configuration.

  • :placement (String) —

    Where in the generated VCL the logging call should be placed. If not set, endpoints with &#x60;format_version&#x60; of 2 are placed in &#x60;vcl_log&#x60; and those with &#x60;format_version&#x60; of 1 are placed in &#x60;vcl_deliver&#x60;.

  • :response_condition (String) —

    The name of an existing condition in the configured endpoint, or leave blank to always execute.

  • :format (String) —

    A Fastly [log format string](docs.fastly.com/en/guides/custom-log-formats). Must produce valid JSON that New Relic Logs can ingest. (default to ‘"timestamp":"%{begin:%Y-%m-%dT%H:%M:%St","time_elapsed":"%Fastly::LoggingNewrelicApi.timetime.elapsedtime.elapsed.usecV","is_tls":"%\"true\", \"false\")V","client_ip":"%Fastly::LoggingNewrelicApi.reqreq.httpreq.http.Fastly-Client-IPV","geo_city":"%Fastly::LoggingNewrelicApi.clientclient.geoclient.geo.cityV","geo_country_code":"%Fastly::LoggingNewrelicApi.clientclient.geoclient.geo.country_codeV","request":"%Fastly::LoggingNewrelicApi.reqreq.requestV","host":"%Fastly::LoggingNewrelicApi.reqreq.httpreq.http.Fastly-Orig-HostV","url":"%Fastly::LoggingNewrelicApi.jsonjson.escape(reqjson.escape(req.url)V","request_referer":"%Fastly::LoggingNewrelicApi.jsonjson.escape(reqjson.escape(req.httpjson.escape(req.http.Referer)V","request_user_agent":"%Fastly::LoggingNewrelicApi.jsonjson.escape(reqjson.escape(req.httpjson.escape(req.http.User-Agent)V","request_accept_language":"%Fastly::LoggingNewrelicApi.jsonjson.escape(reqjson.escape(req.httpjson.escape(req.http.Accept-Language)V","request_accept_charset":"%Fastly::LoggingNewrelicApi.jsonjson.escape(reqjson.escape(req.httpjson.escape(req.http.Accept-Charset)V","cache_status":"%{regsub(fastly_info.state, \"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\", \"\\2\\3\") }V"}’)

  • :format_version (Integer) —

    The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in &#x60;vcl_log&#x60; if &#x60;format_version&#x60; is set to &#x60;2&#x60; and in &#x60;vcl_deliver&#x60; if &#x60;format_version&#x60; is set to &#x60;1&#x60;. (default to FORMAT_VERSION::v2)

  • :token (String) —

    The Insert API key from the Account page of your New Relic account. Required.

  • :region (String) —

    The region to which to stream logs. (default to ‘US’)

Returns:

  • (Array<(LoggingNewrelicResponse, Integer, Hash)>) —

    LoggingNewrelicResponse data, response status code and response headers



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
 
# File 'lib/fastly/api/logging_newrelic_api.rb', line 49

def create_log_newrelic_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingNewrelicApi.create_log_newrelic ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling LoggingNewrelicApi.create_log_newrelic"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling LoggingNewrelicApi.create_log_newrelic"
  end
  allowable_values = ["none", "waf_debug", "null"]
  if @api_client.config.client_side_validation && opts[:'placement'] && !allowable_values.include?(opts[:'placement'])
    fail ArgumentError, "invalid value for \"placement\", must be one of #{allowable_values}"
  end
  allowable_values = [1, 2]
  if @api_client.config.client_side_validation && opts[:'format_version'] && !allowable_values.include?(opts[:'format_version'])
    fail ArgumentError, "invalid value for \"format_version\", must be one of #{allowable_values}"
  end
  allowable_values = ["US", "EU"]
  if @api_client.config.client_side_validation && opts[:'region'] && !allowable_values.include?(opts[:'region'])
    fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/newrelic'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['placement'] = opts[:'placement'] if !opts[:'placement'].nil?
  form_params['response_condition'] = opts[:'response_condition'] if !opts[:'response_condition'].nil?
  form_params['format'] = opts[:'format'] if !opts[:'format'].nil?
  form_params['format_version'] = opts[:'format_version'] if !opts[:'format_version'].nil?
  form_params['token'] = opts[:'token'] if !opts[:'token'].nil?
  form_params['region'] = opts[:'region'] if !opts[:'region'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LoggingNewrelicResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"LoggingNewrelicApi.create_log_newrelic",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoggingNewrelicApi#create_log_newrelic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_log_newrelic(opts = {}) ⇒ InlineResponse200

Delete a New Relic log endpoint Delete the New Relic Logs logging object for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :logging_newrelic_name (String) —

    The name for the real-time logging configuration. (required)

Returns:



134
135
136
137
 
# File 'lib/fastly/api/logging_newrelic_api.rb', line 134

def delete_log_newrelic(opts = {})
  data, _status_code, _headers = delete_log_newrelic_with_http_info(opts)
  data
end

#delete_log_newrelic_with_http_info(opts = {}) ⇒ Array<(InlineResponse200, Integer, Hash)>

Delete a New Relic log endpoint Delete the New Relic Logs logging object for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :logging_newrelic_name (String) —

    The name for the real-time logging configuration. (required)

Returns:

  • (Array<(InlineResponse200, Integer, Hash)>) —

    InlineResponse200 data, response status code and response headers



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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/fastly/api/logging_newrelic_api.rb', line 145

def delete_log_newrelic_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingNewrelicApi.delete_log_newrelic ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  logging_newrelic_name = opts[:'logging_newrelic_name']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling LoggingNewrelicApi.delete_log_newrelic"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling LoggingNewrelicApi.delete_log_newrelic"
  end
  # verify the required parameter 'logging_newrelic_name' is set
  if @api_client.config.client_side_validation && logging_newrelic_name.nil?
    fail ArgumentError, "Missing the required parameter 'logging_newrelic_name' when calling LoggingNewrelicApi.delete_log_newrelic"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/newrelic/{logging_newrelic_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_newrelic_name' + '}', CGI.escape(logging_newrelic_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'InlineResponse200'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"LoggingNewrelicApi.delete_log_newrelic",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoggingNewrelicApi#delete_log_newrelic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_log_newrelic(opts = {}) ⇒ LoggingNewrelicResponse

Get a New Relic log endpoint Get the details of a New Relic Logs logging object for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :logging_newrelic_name (String) —

    The name for the real-time logging configuration. (required)

Returns:



211
212
213
214
 
# File 'lib/fastly/api/logging_newrelic_api.rb', line 211

def get_log_newrelic(opts = {})
  data, _status_code, _headers = get_log_newrelic_with_http_info(opts)
  data
end

#get_log_newrelic_with_http_info(opts = {}) ⇒ Array<(LoggingNewrelicResponse, Integer, Hash)>

Get a New Relic log endpoint Get the details of a New Relic Logs logging object for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :logging_newrelic_name (String) —

    The name for the real-time logging configuration. (required)

Returns:

  • (Array<(LoggingNewrelicResponse, Integer, Hash)>) —

    LoggingNewrelicResponse data, response status code and response headers



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/fastly/api/logging_newrelic_api.rb', line 222

def get_log_newrelic_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingNewrelicApi.get_log_newrelic ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  logging_newrelic_name = opts[:'logging_newrelic_name']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling LoggingNewrelicApi.get_log_newrelic"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling LoggingNewrelicApi.get_log_newrelic"
  end
  # verify the required parameter 'logging_newrelic_name' is set
  if @api_client.config.client_side_validation && logging_newrelic_name.nil?
    fail ArgumentError, "Missing the required parameter 'logging_newrelic_name' when calling LoggingNewrelicApi.get_log_newrelic"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/newrelic/{logging_newrelic_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_newrelic_name' + '}', CGI.escape(logging_newrelic_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LoggingNewrelicResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"LoggingNewrelicApi.get_log_newrelic",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoggingNewrelicApi#get_log_newrelic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_log_newrelic(opts = {}) ⇒ Array<LoggingNewrelicResponse>

List New Relic log endpoints List all of the New Relic Logs logging objects for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

Returns:



287
288
289
290
 
# File 'lib/fastly/api/logging_newrelic_api.rb', line 287

def list_log_newrelic(opts = {})
  data, _status_code, _headers = list_log_newrelic_with_http_info(opts)
  data
end

#list_log_newrelic_with_http_info(opts = {}) ⇒ Array<(Array<LoggingNewrelicResponse>, Integer, Hash)>

List New Relic log endpoints List all of the New Relic Logs logging objects for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

Returns:

  • (Array<(Array<LoggingNewrelicResponse>, Integer, Hash)>) —

    Array<LoggingNewrelicResponse> data, response status code and response headers



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/fastly/api/logging_newrelic_api.rb', line 297

def list_log_newrelic_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingNewrelicApi.list_log_newrelic ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling LoggingNewrelicApi.list_log_newrelic"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling LoggingNewrelicApi.list_log_newrelic"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/newrelic'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<LoggingNewrelicResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"LoggingNewrelicApi.list_log_newrelic",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoggingNewrelicApi#list_log_newrelic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_log_newrelic(opts = {}) ⇒ LoggingNewrelicResponse

Update a New Relic log endpoint Update a New Relic Logs logging object for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :logging_newrelic_name (String) —

    The name for the real-time logging configuration. (required)

  • :name (String) —

    The name for the real-time logging configuration.

  • :placement (String) —

    Where in the generated VCL the logging call should be placed. If not set, endpoints with &#x60;format_version&#x60; of 2 are placed in &#x60;vcl_log&#x60; and those with &#x60;format_version&#x60; of 1 are placed in &#x60;vcl_deliver&#x60;.

  • :response_condition (String) —

    The name of an existing condition in the configured endpoint, or leave blank to always execute.

  • :format (String) —

    A Fastly [log format string](docs.fastly.com/en/guides/custom-log-formats). Must produce valid JSON that New Relic Logs can ingest. (default to ‘"timestamp":"%{begin:%Y-%m-%dT%H:%M:%St","time_elapsed":"%Fastly::LoggingNewrelicApi.timetime.elapsedtime.elapsed.usecV","is_tls":"%\"true\", \"false\")V","client_ip":"%Fastly::LoggingNewrelicApi.reqreq.httpreq.http.Fastly-Client-IPV","geo_city":"%Fastly::LoggingNewrelicApi.clientclient.geoclient.geo.cityV","geo_country_code":"%Fastly::LoggingNewrelicApi.clientclient.geoclient.geo.country_codeV","request":"%Fastly::LoggingNewrelicApi.reqreq.requestV","host":"%Fastly::LoggingNewrelicApi.reqreq.httpreq.http.Fastly-Orig-HostV","url":"%Fastly::LoggingNewrelicApi.jsonjson.escape(reqjson.escape(req.url)V","request_referer":"%Fastly::LoggingNewrelicApi.jsonjson.escape(reqjson.escape(req.httpjson.escape(req.http.Referer)V","request_user_agent":"%Fastly::LoggingNewrelicApi.jsonjson.escape(reqjson.escape(req.httpjson.escape(req.http.User-Agent)V","request_accept_language":"%Fastly::LoggingNewrelicApi.jsonjson.escape(reqjson.escape(req.httpjson.escape(req.http.Accept-Language)V","request_accept_charset":"%Fastly::LoggingNewrelicApi.jsonjson.escape(reqjson.escape(req.httpjson.escape(req.http.Accept-Charset)V","cache_status":"%{regsub(fastly_info.state, \"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\", \"\\2\\3\") }V"}’)

  • :format_version (Integer) —

    The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in &#x60;vcl_log&#x60; if &#x60;format_version&#x60; is set to &#x60;2&#x60; and in &#x60;vcl_deliver&#x60; if &#x60;format_version&#x60; is set to &#x60;1&#x60;. (default to FORMAT_VERSION::v2)

  • :token (String) —

    The Insert API key from the Account page of your New Relic account. Required.

  • :region (String) —

    The region to which to stream logs. (default to ‘US’)

Returns:



365
366
367
368
 
# File 'lib/fastly/api/logging_newrelic_api.rb', line 365

def update_log_newrelic(opts = {})
  data, _status_code, _headers = update_log_newrelic_with_http_info(opts)
  data
end

#update_log_newrelic_with_http_info(opts = {}) ⇒ Array<(LoggingNewrelicResponse, Integer, Hash)>

Update a New Relic log endpoint Update a New Relic Logs logging object for a particular service and version.

Parameters:

  • opts (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (opts):

  • :service_id (String) —

    Alphanumeric string identifying the service. (required)

  • :version_id (Integer) —

    Integer identifying a service version. (required)

  • :logging_newrelic_name (String) —

    The name for the real-time logging configuration. (required)

  • :name (String) —

    The name for the real-time logging configuration.

  • :placement (String) —

    Where in the generated VCL the logging call should be placed. If not set, endpoints with &#x60;format_version&#x60; of 2 are placed in &#x60;vcl_log&#x60; and those with &#x60;format_version&#x60; of 1 are placed in &#x60;vcl_deliver&#x60;.

  • :response_condition (String) —

    The name of an existing condition in the configured endpoint, or leave blank to always execute.

  • :format (String) —

    A Fastly [log format string](docs.fastly.com/en/guides/custom-log-formats). Must produce valid JSON that New Relic Logs can ingest. (default to ‘"timestamp":"%{begin:%Y-%m-%dT%H:%M:%St","time_elapsed":"%Fastly::LoggingNewrelicApi.timetime.elapsedtime.elapsed.usecV","is_tls":"%\"true\", \"false\")V","client_ip":"%Fastly::LoggingNewrelicApi.reqreq.httpreq.http.Fastly-Client-IPV","geo_city":"%Fastly::LoggingNewrelicApi.clientclient.geoclient.geo.cityV","geo_country_code":"%Fastly::LoggingNewrelicApi.clientclient.geoclient.geo.country_codeV","request":"%Fastly::LoggingNewrelicApi.reqreq.requestV","host":"%Fastly::LoggingNewrelicApi.reqreq.httpreq.http.Fastly-Orig-HostV","url":"%Fastly::LoggingNewrelicApi.jsonjson.escape(reqjson.escape(req.url)V","request_referer":"%Fastly::LoggingNewrelicApi.jsonjson.escape(reqjson.escape(req.httpjson.escape(req.http.Referer)V","request_user_agent":"%Fastly::LoggingNewrelicApi.jsonjson.escape(reqjson.escape(req.httpjson.escape(req.http.User-Agent)V","request_accept_language":"%Fastly::LoggingNewrelicApi.jsonjson.escape(reqjson.escape(req.httpjson.escape(req.http.Accept-Language)V","request_accept_charset":"%Fastly::LoggingNewrelicApi.jsonjson.escape(reqjson.escape(req.httpjson.escape(req.http.Accept-Charset)V","cache_status":"%{regsub(fastly_info.state, \"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\", \"\\2\\3\") }V"}’)

  • :format_version (Integer) —

    The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in &#x60;vcl_log&#x60; if &#x60;format_version&#x60; is set to &#x60;2&#x60; and in &#x60;vcl_deliver&#x60; if &#x60;format_version&#x60; is set to &#x60;1&#x60;. (default to FORMAT_VERSION::v2)

  • :token (String) —

    The Insert API key from the Account page of your New Relic account. Required.

  • :region (String) —

    The region to which to stream logs. (default to ‘US’)

Returns:

  • (Array<(LoggingNewrelicResponse, Integer, Hash)>) —

    LoggingNewrelicResponse data, response status code and response headers



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/fastly/api/logging_newrelic_api.rb', line 383

def update_log_newrelic_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: LoggingNewrelicApi.update_log_newrelic ...'
  end
  # unbox the parameters from the hash
  service_id = opts[:'service_id']
  version_id = opts[:'version_id']
  logging_newrelic_name = opts[:'logging_newrelic_name']
  # verify the required parameter 'service_id' is set
  if @api_client.config.client_side_validation && service_id.nil?
    fail ArgumentError, "Missing the required parameter 'service_id' when calling LoggingNewrelicApi.update_log_newrelic"
  end
  # verify the required parameter 'version_id' is set
  if @api_client.config.client_side_validation && version_id.nil?
    fail ArgumentError, "Missing the required parameter 'version_id' when calling LoggingNewrelicApi.update_log_newrelic"
  end
  # verify the required parameter 'logging_newrelic_name' is set
  if @api_client.config.client_side_validation && logging_newrelic_name.nil?
    fail ArgumentError, "Missing the required parameter 'logging_newrelic_name' when calling LoggingNewrelicApi.update_log_newrelic"
  end
  allowable_values = ["none", "waf_debug", "null"]
  if @api_client.config.client_side_validation && opts[:'placement'] && !allowable_values.include?(opts[:'placement'])
    fail ArgumentError, "invalid value for \"placement\", must be one of #{allowable_values}"
  end
  allowable_values = [1, 2]
  if @api_client.config.client_side_validation && opts[:'format_version'] && !allowable_values.include?(opts[:'format_version'])
    fail ArgumentError, "invalid value for \"format_version\", must be one of #{allowable_values}"
  end
  allowable_values = ["US", "EU"]
  if @api_client.config.client_side_validation && opts[:'region'] && !allowable_values.include?(opts[:'region'])
    fail ArgumentError, "invalid value for \"region\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/service/{service_id}/version/{version_id}/logging/newrelic/{logging_newrelic_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'logging_newrelic_name' + '}', CGI.escape(logging_newrelic_name.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['name'] = opts[:'name'] if !opts[:'name'].nil?
  form_params['placement'] = opts[:'placement'] if !opts[:'placement'].nil?
  form_params['response_condition'] = opts[:'response_condition'] if !opts[:'response_condition'].nil?
  form_params['format'] = opts[:'format'] if !opts[:'format'].nil?
  form_params['format_version'] = opts[:'format_version'] if !opts[:'format_version'].nil?
  form_params['token'] = opts[:'token'] if !opts[:'token'].nil?
  form_params['region'] = opts[:'region'] if !opts[:'region'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LoggingNewrelicResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['token']

  new_options = opts.merge(
    :operation => :"LoggingNewrelicApi.update_log_newrelic",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: LoggingNewrelicApi#update_log_newrelic\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end