Skip to content

Latest commit

 

History

History
78 lines (52 loc) · 4.63 KB

README.md

File metadata and controls

78 lines (52 loc) · 4.63 KB
Raw

OCI Logging Service - Spring Framework Sample

This sample application demonstrates how to use the OCI Logging Spring Cloud APIs to ingest logs into the OCI Logging Service.

This application has the following classes:

  • LoggingController- REST Container class which contains the REST APIs for performing each of the operations in the previous section.
  • SpringCloudOciLoggingSampleApplication - Spring Boot application class, which when run, will launch the application.

Prerequisites

Configuration items that are needed to run the Application can be configured in application.properties. These include the following:

  • spring.cloud.oci.region.static - OCI Region name(Ex: us-phoenix-1) where the OCI resources need to be created.
  • spring.cloud.oci.config.type - Authentication type to be used for OCI. It could be one of the following: RESOURCE_PRINCIPAL, INSTANCE_PRINCIPAL, SESSION_TOKEN, SIMPLE and FILE. If nothing is specified, FILE type is used by default.
  • spring.cloud.oci.config.file - The file path set to this property will be used as a configuration file for FILE type authentication which uses the OCI configuration file. If nothing is specified, the OCI configuration file from the user's home directory will be used.
  • spring.cloud.oci.config.profile - Profile to be used in the OCI configuration file for Authentication. If a profile is not specified, a DEFAULT profile will be used.
  • spring.cloud.oci.logging.logId - OCID of the OCI Log where the logs need to be ingested.

If the spring.cloud.oci.config.type is SIMPLE, then the following properties also need to be set in the application.properties.

  • spring.cloud.oci.config.userId
  • spring.cloud.oci.config.tenantId
  • spring.cloud.oci.config.fingerprint
  • spring.cloud.oci.config.privateKey
  • spring.cloud.oci.config.passPhrase
  • spring.cloud.oci.config.region

Refer to OCI SDK Authentication Methods for more details on the Authentication types supported by OCI.

Quick Launch

To try out this sample in your OCI tenancy, click on the Open in Code Editor button below to clone and launch the OCI Code Editor for this sample.

You can also clone the repository manually with the following instructions.

git clone https://github.com/oracle/spring-cloud-oci.git spring-cloud-oci

Let's start

  1. Run mvn clean install from the root directory of the code repository.
  2. To start the application, run the following command from the sample root directory.
mvn spring-boot:run

The default service port is 8080. You can change this with the server.port property.

Try the Sample

The base URL for all the APIs exposed in this application is http://localhost:8080//demoapp/api/logging/

Using the base URL, the following APIs can be invoked:

API Method URI Request Params
Put Log POST putlog logText

References

Contributing

This project is open source. Submit your contributions by forking this repository and submitting a pull request. Oracle appreciates any contributions that are made by the open source community.

License

Copyright (c) 2023 Oracle and/or its affiliates.

Licensed under the Universal Permissive License (UPL), Version 1.0.

See LICENSE for more details.

ORACLE AND ITS AFFILIATES DO NOT PROVIDE ANY WARRANTY WHATSOEVER, EXPRESS OR IMPLIED, FOR ANY SOFTWARE, MATERIAL OR CONTENT OF ANY KIND CONTAINED OR PRODUCED WITHIN THIS REPOSITORY, AND IN PARTICULAR SPECIFICALLY DISCLAIM ANY AND ALL IMPLIED WARRANTIES OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE. FURTHERMORE, ORACLE AND ITS AFFILIATES DO NOT REPRESENT THAT ANY CUSTOMARY SECURITY REVIEW HAS BEEN PERFORMED WITH RESPECT TO ANY SOFTWARE, MATERIAL OR CONTENT CONTAINED OR PRODUCED WITHIN THIS REPOSITORY. IN ADDITION, AND WITHOUT LIMITING THE FOREGOING, THIRD PARTIES MAY HAVE POSTED SOFTWARE, MATERIAL OR CONTENT TO THIS REPOSITORY WITHOUT ANY REVIEW. USE AT YOUR OWN RISK.