\ No newline at end of file
diff --git a/blog/mdx-blog-post/index.html b/blog/mdx-blog-post/index.html
index ed27f8019..bcd2ef788 100644
--- a/blog/mdx-blog-post/index.html
+++ b/blog/mdx-blog-post/index.html
@@ -2,15 +2,15 @@
-
-MDX Blog Post | Athena
-
-
-
+
+MDX Blog Post | Athena
+
+
+
-
Graph APIs are an evolution of web service APIs that serve and manipulate data for mobile & web applications. They have
a number of characteristics that make them well suited to this task:
@@ -32,6 +32,6 @@
Athena supports the two most widely adopted standards for graph APIs:
JSON-API is a specification for building REST APIs for CRUID (create, read, update, and delete)
operations.
Similar to GraphQL, it allows the client to control what is returned in the response payload. Unlike GraphQL, the
JSON-API spells out hot to perform file operations instead of file metadata operations.
@@ -30,6 +30,6 @@
File Identi
note
In order to replace the default file ID generator, the custom implementation
must be bound explicitly through BinderFactory. For example, when application implements a
generator called 'MyIdGenerator', it will load via
NOTE: In case you are not familiar with Jersey, it is a parallel technology with "Spring Boot framework". Athena
offers absolutely NO support for Spring and will remain as an exclusive Jersey application in the future, because
Jersey, alone with its backing technology HK2, is the reference-implementation of
@@ -37,7 +37,7 @@
Download Jett
For JDK 17, which is the version JWT runs on, it's been tested that Jetty 11.0.15 worked. Hence, we will use
"11.0.15" release as
an example:
-
+
Put the tar.gz file into a location of your choice as the installation path and extract the Jetty binary using
tar -xzvf jetty-home-11.0.15.tar.gz
The extracted directory jetty-home-11.0.15 is the Jetty distribution. We call this directory $JETTY_HOME, which
@@ -60,6 +60,6 @@
Release Ver
Athena follows semantic versioning for its releases. Minor and patch versions only have the
version components of MAJOR.MINOR.PATCH.
Major releases are often pre-released prior to the publication of the final version. Pre-releases have the format of
-MAJOR.MINOR.PATCH-prCANDIDATE. For example, 5.0.0-pr2 is release candidate 2 of the Athena 5.0.0 version.
Jersey uses HK2 as its dependency injection (DI) system. We can use other
injection systems, but its infrastructure is built with HK2, and allows us to also use it within our applications.
Setting up simple dependency injection with Jersey takes just a few lines of code. Let say for example we have a service
we would like to inject into our resources.
@@ -55,6 +55,6 @@
public class GreetingServiceFactory implements Factory<GreetingService> { @Context UriInfo uriInfo; @Override public GreetingService provide() { return new GreetingService( uriInfo.getQueryParameters().getFirst("name")); } @Override public void dispose(GreetingService service) { /* noop */ } }
Here we have a factory, that gets request information from the UriInfo, in this case a query parameters, and we create
the GreetingService from it. To configure it, we use the following syntax
We're big believers in testing our code, both for correctness, as well as to ensure that changes don't unintentionally
break existing contracts unintentionally. For example, we rely heavily on the Spock
framework for our backend service tests, and see a lot of benefit from it's conciseness, built-in
@@ -21,18 +21,18 @@
Servlet Test
tip
The design of athena-core tests, servlet tests in particular, draws extensively from
fili
One noticeable deviation is that since some of Fili's classes have made it possible for themselves to be mutable,
which Athena doesn't do, the stubbing is defined not on these classes, but on
-ApplicationState, which
+ApplicationState, which
is a modified adaption of Fili ApplicationState
Executing the statement above will start a Grizzly container. After that all Athena
endpoints are ready to receive test requests.
tip
When writing tests for
-FileServlet, make sure
+FileServlet, make sure
MultiPartFeature.class is also passed in as a resource class since the file uploading involves a separate Jersey
component enabled by it. For example:
jerseyTestBinder = new BookJerseyTestBinder(true, FileServlet.class, MultiPartFeature.class)
The first boolean argument (true) is a flag to indicate whether or not, on executing the statement, servlet container
@@ -54,10 +54,10 @@
java.lang.IllegalStateException: org.glassfish.jersey.server.model.ModelValidationException: Validation of the application resource model has failed during application initialization. [FATAL] No injection source found for a parameter of type public javax.ws.rs.core.Response ... Caused by: org.glassfish.jersey.server.model.ModelValidationException: Validation of the application resource model has failed during application initialization.
Athena uses ResourceConfig type for configuration. We need to register the MultiPartFeature. Instead of using
-Athena ResourceConfig,
+Athena ResourceConfig,
servlet test spec configures with the native
Jersey ResourceConfig.
The reason is so that we could bind certain resource classes that we only need in a test spec to enhance test
@@ -88,22 +88,22 @@
I Use IntelliJ. Is There Any Way to Easily Sync up with Athena's Code styles
For the moment, we have distilled the most important code style conventions with respect to Athena's code as IntelliJ
settings. If you are using IntelliJ, you may import these code style settings by importing the
Athena-Project-intellij-code-style.xml file in the root of the repo. The setting for the project will appear as a new
Scheme named Athena-Project under IntelliJ's Editor -> Code Style section.
Alternatively, you might check the xml file that is included in the jar and map its settings to your development
-environment.
reading and writing files (.mp3, .pdf, etc.) to/from an object store.
providing "transactions" that make all file operations atomic in a single request.
@@ -42,6 +42,6 @@
Multiple Sto
but some others may require a different object storage backend or have other needs to specialize the behavior of the
store. The multiplex store in Athena manages multiple stores - delegating calls to the appropriate store which is
responsible for a particular file.
-
\ No newline at end of file
diff --git a/docs/filestores/local-swift/index.html b/docs/filestores/local-swift/index.html
index 05e9ef9cd..27e94b842 100644
--- a/docs/filestores/local-swift/index.html
+++ b/docs/filestores/local-swift/index.html
@@ -2,14 +2,14 @@
-
-Spinning Up A Local Swift Instance | Athena
-
-
-
+
+Spinning Up A Local Swift Instance | Athena
+
+
+
-
The easiest way to get started with Athena is to use the Athena Book App Starter. The starter bundles all of the
dependencies we will need to stand up a web service. This tutorial uses the starter, and all of the code is
available here. We will deploy and play with this example locally
Logs are an important tool for debugging problems, as well as for gaining insight into how something is running under
otherwise normal conditions. Because logs are so useful, it's tempting to always log everything that's going on, but
processing logs is much more work than it would seem and writing too many logs has a significant negative impact on
performance.
Athena was built from the start to be easy to operate and debug. There are 3 primary ways in which Athena makes
debugging and gathering information about how it's running easy.
Athena has strict guidelines around
what information should be logged, when it should be logged, and what level it should be logged at. Here's a brief
summary of the log levels and what they contain:
Level
Meaning
Error
System-caused problem preventing correct results for requests. Major, "wake up a human" events.
Warn
Something's wrong, like no caching, but can still correctly respond to requests. A human should investigate.
Info
Working as expected. Information needed for monitoring. Answers "Are things healthy."
Debug
High-level data flow and errors. Rich insight, but not overwhelming. Per-request errors, but not happy-path.
Trace
Most verbose. Full data flow. Not intended to be used in production, or very rarely.
Athena also has a tracing mechanism that records and collects information about each request as it flows through the
-system. This information is called the Request Log and it gets logged at the INFO level
+system. This information is called the Request Log and it gets logged at the INFO level
when the response for a request is sent.
The Request Log is modular, and has a number of different components, depending on which type of request is being
served. All Request Logs contain a Durations, Threads, and Preface component at the beginning, an Epilogue component at
@@ -40,7 +40,7 @@
Athena uses the Metrics library (formerly Dropwizard Metrics) for gathering and
reporting on runtime metrics and indicators. Typically, these are exposed through an admin servlet, and if that's
-enabled then there is a list of Key Performance Indicators (KPIs) that are exposed through the /metrics
+enabled then there is a list of Key Performance Indicators (KPIs) that are exposed through the /metrics
endpoint. The KPI document doesn't go into detail about what each of the KPIs mean, but it gives a rough overview of why
they matter.
Health Checks<
just like metrics, at /status. Each of the health checks has a message and a status, and if any of the checks fail,
the HTTP Status Code for that /status request will be a 500 instead of a 200 to indicate the system is unhealthy.
These health checks are also used to gate /file and /metadata requests, with Athena returning
-503 Service Unavailable if it doesn't think it is healthy.
Athena has two main configuration avenues, the domain object configuration (File Store, Meta Store, and Data Fetchers)
which happens via compiled Java code, and system configuration via properties. The domain configuration is
covered elsewhere, and we'll only cover the system configuration infrastructure here.
The system for property configuration that Athena uses lives in it's own sub-module. This system
@@ -26,6 +26,6 @@
Priority
Source
Notes
(High) 1
Environment variables
2
Java properties
3
userConfig.properties
5
applicationConfig.properties
Every application MUST provide one of these
tip
Since userConfig.properties is often used while developing to turn features on and off, .gitignore includes
-a rule to ignore this file by default to help prevent checking it in accidentally.
The following offers some solutions to common issues when setting up and using Athena. If you come across any issues
that you think belong here, please feel free to contribute.
Checkstyle Error - "Extra lines between braces [RegexpMultiline]"
This is an Athena-custom checkstyle rule which simple disallow the following code snippet:
} }
@@ -23,6 +23,6 @@
} }
Note that no extra line can be seen in this reported case. The most probably cause might be a shared development
environment where one team member wrote code on Windows, which uses CRLF line endings, and the other uses UNIX/Mac.
-We should replace all CRLF endings with UNIX '\n' endings.
Athena makes it easy to build and maintain GraphQL web services for managing file metadata. Athena's API is clean and user-friendly, hiding the complexities of complicated data storage and query optimization from end-users
Specialized in Object Storage
Designed for Big Data and scalability, Athena has first-class support for OpenStack Swift and Hadoop HDFS as back-ends and flexible pipeline-style architecture which handles nearly any back-end for data storage
Cloud Native in Nature
The long-term goal of Athena is to make it part of OpenStack ecosystem so to make it a quickly-provisioned and easily-managed SaaS infrastructural component
Athena makes it easy to build and maintain GraphQL web services for managing file metadata. Athena's API is clean and user-friendly, hiding the complexities of complicated data storage and query optimization from end-users
Specialized in Object Storage
Designed for Big Data and scalability, Athena has first-class support for OpenStack Swift and Hadoop HDFS as back-ends and flexible pipeline-style architecture which handles nearly any back-end for data storage
Cloud Native in Nature
The long-term goal of Athena is to make it part of OpenStack ecosystem so to make it a quickly-provisioned and easily-managed SaaS infrastructural component
\ No newline at end of file
diff --git a/markdown-page/index.html b/markdown-page/index.html
index fe368ca45..cb68c19c2 100644
--- a/markdown-page/index.html
+++ b/markdown-page/index.html
@@ -2,14 +2,14 @@
-
-Markdown page example | Athena
-
-
-
+
+Markdown page example | Athena
+
+
+
-
You don't need React to write simple standalone pages.
\ No newline at end of file
diff --git a/sitemap.xml b/sitemap.xml
index f7542002a..cd8adbe93 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -1 +1 @@
-https://qubitpi.github.io/athena/weekly0.5https://qubitpi.github.io/athena/blogweekly0.5https://qubitpi.github.io/athena/blog/archiveweekly0.5https://qubitpi.github.io/athena/blog/mdx-blog-postweekly0.5https://qubitpi.github.io/athena/blog/tagsweekly0.5https://qubitpi.github.io/athena/blog/tags/docusaurusweekly0.5https://qubitpi.github.io/athena/markdown-pageweekly0.5https://qubitpi.github.io/athena/docs/category/contributor-guideweekly0.5https://qubitpi.github.io/athena/docs/client-apisweekly0.5https://qubitpi.github.io/athena/docs/client-apis/json-apiweekly0.5https://qubitpi.github.io/athena/docs/contributing/developmentweekly0.5https://qubitpi.github.io/athena/docs/contributing/jersey-di-using-hk2weekly0.5https://qubitpi.github.io/athena/docs/contributing/testweekly0.5https://qubitpi.github.io/athena/docs/faqweekly0.5https://qubitpi.github.io/athena/docs/filestoreweekly0.5https://qubitpi.github.io/athena/docs/filestores/local-swiftweekly0.5https://qubitpi.github.io/athena/docs/glossaryweekly0.5https://qubitpi.github.io/athena/docs/introweekly0.5https://qubitpi.github.io/athena/docs/kpiweekly0.5https://qubitpi.github.io/athena/docs/logging-guidelinesweekly0.5https://qubitpi.github.io/athena/docs/monitoring-and-operationsweekly0.5https://qubitpi.github.io/athena/docs/system-configweekly0.5https://qubitpi.github.io/athena/docs/troubleshootingweekly0.5
\ No newline at end of file
+https://athena.qubitpi.org/blogweekly0.5https://athena.qubitpi.org/blog/archiveweekly0.5https://athena.qubitpi.org/blog/mdx-blog-postweekly0.5https://athena.qubitpi.org/blog/tagsweekly0.5https://athena.qubitpi.org/blog/tags/docusaurusweekly0.5https://athena.qubitpi.org/markdown-pageweekly0.5https://athena.qubitpi.org/docs/category/contributor-guideweekly0.5https://athena.qubitpi.org/docs/client-apisweekly0.5https://athena.qubitpi.org/docs/client-apis/json-apiweekly0.5https://athena.qubitpi.org/docs/contributing/developmentweekly0.5https://athena.qubitpi.org/docs/contributing/jersey-di-using-hk2weekly0.5https://athena.qubitpi.org/docs/contributing/testweekly0.5https://athena.qubitpi.org/docs/faqweekly0.5https://athena.qubitpi.org/docs/filestoreweekly0.5https://athena.qubitpi.org/docs/filestores/local-swiftweekly0.5https://athena.qubitpi.org/docs/glossaryweekly0.5https://athena.qubitpi.org/docs/introweekly0.5https://athena.qubitpi.org/docs/kpiweekly0.5https://athena.qubitpi.org/docs/logging-guidelinesweekly0.5https://athena.qubitpi.org/docs/monitoring-and-operationsweekly0.5https://athena.qubitpi.org/docs/system-configweekly0.5https://athena.qubitpi.org/docs/troubleshootingweekly0.5https://athena.qubitpi.org/weekly0.5
\ No newline at end of file
